SPI
SPI API Status
API |
BK7258 |
BK7258_cp1 |
---|---|---|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
|
|
Y |
Y |
|
Y |
Y |
|
Y |
Y |
SPI UNIT Number
Capability |
BK7258 |
BK7258_cp1 |
---|---|---|
UNIT Number |
3 |
3 |
SPI Pin and GPIO Map
SPI Pin |
BK7258 |
BK7258_cp1 |
---|---|---|
SPI0 SCK |
44 |
44 |
SPI0 CSN |
45 |
45 |
SPI0 MOSI |
46 |
46 |
SPI0 MISO |
47 |
47 |
SPI1 SCK |
2 |
2 |
SPI1 CSN |
3 |
3 |
SPI1 MOSI |
4 |
4 |
SPI1 MISO |
5 |
5 |
SPI2 SCK |
14 |
14 |
SPI2 CSN |
15 |
15 |
SPI2 MOSI |
16 |
16 |
SPI2 MISO |
17 |
17 |
SPI API Reference
Header File
Functions
-
bk_err_t bk_spi_driver_init(void)
Init the SPI driver.
This API init the resoure common:
Init SPI driver control memory
- Attention
1. This API should be called before any other SPI APIs.
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_driver_deinit(void)
Deinit the SPI driver.
This API free all resource related to SPI and disable SPI.
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_init(spi_id_t id, const spi_config_t *config)
Init the SPI id.
This API init the SPI id:
Power up the SPI id
Configure the SPI id clock
Map the SPI id to dedicated GPIO port
Set the SPI parameters
Start the SPI id
- Parameters
id – SPI id
config – SPI parameter settings
- Returns
BK_OK: succeed
BK_ERR_NULL_PARAM: SPI config paramter is NULL
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id is invalid
others: other errors.
-
bk_err_t bk_spi_deinit(spi_id_t id)
Deinit the SPI id.
This API deinit the SPI id:
Stop the SPI id
Disable the SPI id interrupt
Power down the SPI id
- Parameters
id – SPI id
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_mode(spi_id_t id, spi_mode_t mode)
Set the SPI mode.
- Parameters
id – SPI id
mode – SPI mode
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_bit_width(spi_id_t id, spi_bit_width_t bit_width)
Set the SPI bit width.
- Parameters
id – SPI id
bit_width – SPI bit width
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_wire_mode(spi_id_t id, spi_wire_mode_t wire_mode)
Set the SPI wire mode.
- Parameters
id – SPI id
wire_mode – SPI wire mode
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_baud_rate(spi_id_t id, uint32_t baud_rate)
Set the SPI baud rate.
- Parameters
id – SPI id
baud_rate – SPI baud rate
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_bit_order(spi_id_t id, spi_bit_order_t bit_order)
Set the SPI bit order.
- Parameters
id – SPI id
bit_order – SPI bit order
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_set_role(spi_id_t id, spi_role_t role)
-
bk_err_t bk_spi_register_rx_isr(spi_id_t id, spi_isr_t isr, void *param)
Register the RX interrupt service routine for SPI id.
- Parameters
id – spi id
isr – SPI RX callback
param – SPI RX callback parameter
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_register_tx_finish_isr(spi_id_t id, spi_isr_t isr, void *param)
Register the TX finish interrupt service routine for SPI id.
- Parameters
id – SPi id
isr – SPI TX finish callback
param – SPi TX callback parameter
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_write_bytes(spi_id_t id, const void *data, uint32_t size)
Send data to the SPI port from a given buffer and length.
- Parameters
id – spi id
data – data buffer address
size – data length to send
- Returns
BK_OK: succeed
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id number is invalid
BK_ERR_SPI_ID_NOT_INIT: SPI id not init
others: other errors.
-
bk_err_t bk_spi_read_bytes(spi_id_t id, void *data, uint32_t size)
SPI read bytes from SPI buffer.
- Parameters
id – SPI id
data – pointer to the buffer
size – data length to read
- Returns
BK_OK: succeed
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id number is invalid
BK_ERR_SPI_ID_NOT_INIT: SPI id not init
others: other errors.
-
bk_err_t bk_spi_transmit(spi_id_t id, const void *tx_data, uint32_t tx_size, void *rx_data, uint32_t rx_size)
SPI write and read bytes.
- Parameters
id – SPI id
tx_data – write data buffer address
tx_size – data length to read
rx_data – pointer to the receive buffer
rx_size – data length to read
timeout_ms – timeout ms, if set BEKEN_WAIT_FOREVER, read will wait forever
- Returns
BK_OK: succeed
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id number is invalid
BK_ERR_SPI_ID_NOT_INIT: SPI id not init
others: other errors.
-
bk_err_t bk_spi_register_rx_finish_isr(spi_id_t id, spi_isr_t isr, void *param)
Register the RX finish interrupt service routine for SPI id.
- Parameters
id – spi id
isr – SPI RX callback
param – SPI RX callback parameter
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_unregister_rx_isr(spi_id_t id)
Unregister the RX interrupt service routine for SPI id.
- Parameters
id – spi id
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_unregister_rx_finish_isr(spi_id_t id)
Unregister the RX finish interrupt service routine for SPI id.
- Parameters
id – spi id
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_unregister_tx_finish_isr(spi_id_t id)
Unregister the TX finish interrupt service routine for SPI id.
- Parameters
id – spi id
- Returns
BK_OK: succeed
others: other errors.
-
bk_err_t bk_spi_write_bytes_async(spi_id_t id, const void *data, uint32_t size)
Send data to the SPI port from a given buffer and length in async mode.
- Parameters
id – spi id
data – data buffer address
size – data length to send
- Returns
BK_OK: succeed
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id number is invalid
BK_ERR_SPI_ID_NOT_INIT: SPI id not init
others: other errors.
-
bk_err_t bk_spi_read_bytes_async(spi_id_t id, void *data, uint32_t size)
SPI read bytes from SPI buffer in async mode.
- Parameters
id – SPI id
data – pointer to the buffer
size – data length to read
- Returns
BK_OK: succeed
BK_ERR_SPI_NOT_INIT: SPI driver not init
BK_ERR_SPI_INVALID_ID: SPI id number is invalid
BK_ERR_SPI_ID_NOT_INIT: SPI id not init
others: other errors.
SPI API Typedefs
Header File
Structures
-
struct spi_int_config_t
Type Definitions
Header File
Structures
-
struct spi_config_t
Public Members
-
spi_role_t role
SPI as master or slave
-
spi_bit_width_t bit_width
SPI data bit witdth
-
spi_polarity_t polarity
SPI clock polarity
-
spi_phase_t phase
SPI clock phase
-
spi_wire_mode_t wire_mode
SPI wire mode
-
uint32_t baud_rate
SPI transmit and receive SCK clock
-
spi_bit_order_t bit_order
SPI bit order, MSB/LSB
-
spi_role_t role
Macros
-
BK_ERR_SPI_NOT_INIT
SPI driver not init
-
BK_ERR_SPI_INVALID_ID
SPI id number is invalid
-
BK_ERR_SPI_ID_NOT_INIT
SPI ID not init
-
BK_ERR_SPI_RX_TIMEOUT
SPI receive data timeout
-
BK_ERR_SPI_TX_TIMEOUT
SPI send data timeout
-
BK_ERR_SPI_FIFO_WR_NOT_READY
SPI tx fifo write not ready
-
BK_ERR_SPI_FIFO_RD_NOT_READY
SPI rx fifo read not ready
-
BK_ERR_SPI_DUPLEX_SIZE_NOT_EQUAL
SPI duplex tx rx size not equal
Type Definitions
-
typedef uint8_t spi_unit_t
spi uint id
Enumerations
-
enum spi_role_t
Values:
-
enumerator SPI_ROLE_SLAVE
SPI as slave
-
enumerator SPI_ROLE_MASTER
SPI as master
-
enumerator SPI_ROLE_SLAVE
-
enum spi_bit_width_t
Values:
-
enumerator SPI_BIT_WIDTH_8BITS
SPI bit width 8bits
-
enumerator SPI_BIT_WIDTH_16BITS
SPI bit width 16bits
-
enumerator SPI_BIT_WIDTH_8BITS
-
enum spi_polarity_t
Values:
-
enumerator SPI_POLARITY_LOW
SPI clock polarity low
-
enumerator SPI_POLARITY_HIGH
SPI clock polarity high
-
enumerator SPI_POLARITY_LOW
-
enum spi_phase_t
Values:
-
enumerator SPI_PHASE_1ST_EDGE
SPI clock phase the first edge
-
enumerator SPI_PHASE_2ND_EDGE
SPI clock phase the second edge
-
enumerator SPI_PHASE_1ST_EDGE
-
enum spi_mode_t
Values:
-
enumerator SPI_POL_MODE_0
SPI mode 0
-
enumerator SPI_POL_MODE_1
SPI mode 1
-
enumerator SPI_POL_MODE_2
SPI mode 2
-
enumerator SPI_POL_MODE_3
SPI mode 3
-
enumerator SPI_POL_MODE_0
-
enum spi_wire_mode_t
Values:
-
enumerator SPI_4WIRE_MODE
SPI four wire mode
-
enumerator SPI_3WIRE_MODE
SPI three wire mode
-
enumerator SPI_4WIRE_MODE
-
enum spi_bit_order_t
Values:
-
enumerator SPI_MSB_FIRST
SPI MSB first
-
enumerator SPI_LSB_FIRST
SPI LSB first
-
enumerator SPI_MSB_FIRST