| orphan: |
|---|
| vendor: | XMOS |
|---|---|
| version: | 5.0.1 |
| scope: | General Use |
| description: | A library to control XMOS devices from a host |
| category: | General Purpose |
| keywords: | USB, Serial interface, IO |
| devices: | xcore-200, xcore.ai |
The Device Control Library is a protocol layer that handles the routing of control messages between a host and one or many controllable resources within the controlled device. The library is transport agnostic and can be used with physical transports such as I2C, SPI, USB or XSCOPE.
- Simple read/write API
- Fully acknowledged protocol
- Includes different transports including I2C slave, USB requests, XSCOPE over XCONNECT and SPI slave
- Supports multiple resources per task
The table below shows combinations of host and transport mechanisms that are currently supported. Adding new transport layers and/or hosts is straightforward where the hardware supports it.
| Host | I2C | USB | XSCOPE | SPI |
|---|---|---|---|---|
| PC / Windows | Yes | Yes | ||
| PC / OSX | Yes | Yes | ||
| Raspberry Pi / Linux | Yes | Yes | Yes* | |
| XCORE | Yes |
Less than 1KB of code space is needed for the target device, plus whatever the chosen transport layer library requires. The API is in the form of function calls, so no additional threads are consumed. I/O requirements also depend on which transport layer is used.
- No support for SPI on recent Raspberry Pi OS versions due to library compatibility issues.
- XMOS XTC Tools: 15.3.1
- lib_logging (https://www.xmos.com/libraries/lib_logging)
- lib_xassert (https://www.xmos.com/libraries/lib_xassert)
- None
This package is supported by XMOS Ltd. Issues can be raised against the software at www.xmos.com/support or using GitHub issues.