Skip to content

ItsDwyer/xcore_sdk

 
 

Repository files navigation

XCORE:registered: SDK Repository

Version Issues Contributors PRs Welcome

The XCORE SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on xcore processors. It is composed of the following components:

  • Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development.
  • Libraries core to DSP applications, including vectorized math. These libraries support bare-metal and RTOS application development.
  • Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development.
  • Libraries that enable multi-core FreeRTOS development on xcore including a wide array of RTOS drivers and middleware.
  • Code Examples - Examples showing a variety of xcore features based on bare-metal and FreeRTOS programming.

The SDK is designed to be used in conjunction with the xcore.ai Explorer board evaluation kit. The example applications compile targeting this board. Further information about the Explorer board and xcore.ai devices is available to on www.xmos.ai.

Build Status

Build Type Status
CI (Linux) CI
CI (Linux) CI
Docs CI

Cloning

Some dependent components are included as git submodules. These can be obtained by cloning this repository with the following command:

git clone --recurse-submodules https://github.com/xmos/xcore_sdk.git

Development Tools

Download and install the xcore XTC Tools version 15.1.0 or newer. If you already have the XTC Toolchain installed, you can check the version with the following command:

xcc --version

Documentation

See the official documentation for more information including:

  • Instructions for installing
  • Getting started guides
  • Programming tutorials
  • API references

Getting Help

A Github issue should be the primary method of getting in touch with the XMOS XCORE SDK development team.

License

This Software is subject to the terms of the XMOS Public Licence: Version 1. Copyrights and licenses for third party components can be found in Copyrights and Licenses.

Contribution

Contributions are greatly welcomed! For guidelines of contribution please check the Contributing Guide.

About

ELECOMP 2022-2023

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 85.9%
  • Shell 5.9%
  • Python 4.1%
  • CMake 4.1%