代码拉取完成，页面将自动刷新
同步操作将从 OpenHarmony/docs 强制同步，此操作会覆盖自 Fork 仓库以来所做的任何修改，且无法恢复！！！
确定后同步将在后台操作，完成时将刷新页面，请耐心等待。
Defines standard APIs of the Serial Peripheral Interface (SPI) capabilities.
The SPI module abstracts the SPI capabilities of different system platforms to provide stable APIs for driver development. This module can create and destroy SPI device handles, read and write SPI data, and obtain and set configuration parameters.
Since:
1.0
|
Defines standard SPI-specific interfaces for driver development. |
|
Defines the general SPI device descriptor, which can be used as the unique identifier of an SPI device. When operating an SPI device, you need to specify a descriptor of the SpiDevInfo type, and obtain the handle of the SPI device by calling SpiOpen. |
|
|
SPI_CLK_PHASE (1 << 0) |
Indicates the SPI clock phase. The value 0 indicates that data will be sampled on the first clock edge, and 1 indicates that data will be sampled on the second clock edge. |
|
SPI_CLK_POLARITY (1 << 1) |
Indicates the SPI clock polarity. The value 0 indicates a low-level clock signal in the idle state, and 1 indicates a high-level clock signal in the idle state. |
|
SPI_MODE_3WIRE (1 << 2) |
Indicates that a single data line is used for both input and output. |
|
SPI_MODE_LOOP (1 << 3) |
|
|
SPI_MODE_LSBFE (1 << 4) |
Indicates the SPI data transfer order. The value 0 indicates that data is transferred from the most significant bit (MSB) to the least significant bit (LSB), and 1 indicates the opposite. |
|
SPI_MODE_NOCS (1 << 5) |
Indicates that there is only one SPI device, and no chip select (CS) is required. |
|
SPI_MODE_CS_HIGH (1 << 6) |
Indicates that the CS level is high when an SPI device is selected. |
|
SPI_MODE_READY (1 << 7) |
Indicates that the SPI device is set to low for pausing data transfer. |
|
SpiTransferMode { SPI_INTERRUPT_TRANSFER = 0, SPI_POLLING_TRANSFER, SPI_DMA_TRANSFER } |
|
SpiOpen (const struct SpiDevInfo *info) |
struct DevHandle * |
|
SpiTransfer (struct DevHandle *handle, struct SpiMsg *msgs, uint32_t count) |
|
|
SpiRead (struct DevHandle *handle, uint8_t *buf, uint32_t len) |
|
|
SpiWrite (struct DevHandle *handle, uint8_t *buf, uint32_t len) |
|
#define SPI_CLK_PHASE (1 << 0)
Description:
Indicates the SPI clock phase. The value 0 indicates that data will be sampled on the first clock edge, and 1 indicates that data will be sampled on the second clock edge.
#define SPI_CLK_POLARITY (1 << 1)
Description:
Indicates the SPI clock polarity. The value 0 indicates a low-level clock signal in the idle state, and 1 indicates a high-level clock signal in the idle state.
#define SPI_MODE_3WIRE (1 << 2)
Description:
Indicates that a single data line is used for both input and output.
#define SPI_MODE_CS_HIGH (1 << 6)
Description:
Indicates that the CS level is high when an SPI device is selected.
#define SPI_MODE_LOOP (1 << 3)
Description:
Indicates the SPI loopback mode.
#define SPI_MODE_LSBFE (1 << 4)
Description:
Indicates the SPI data transfer order. The value 0 indicates that data is transferred from the most significant bit (MSB) to the least significant bit (LSB), and 1 indicates the opposite.
#define SPI_MODE_NOCS (1 << 5)
Description:
Indicates that there is only one SPI device, and no chip select (CS) is required.
#define SPI_MODE_READY (1 << 7)
Description:
Indicates that the SPI device is set to low for pausing data transfer.
enum [SpiTransferMode](SPI.md#ga55946d1d895fc2b7b33007019de1668f)
Description:
Enumerates transfer modes of SPI data.
Attention:
The specific SPI controller determines which variables in this structure are supported.
| SPI_INTERRUPT_TRANSFER | |
| SPI_POLLING_TRANSFER | |
| SPI_DMA_TRANSFER |
void SpiClose (struct [DevHandle](DevHandle.md) * handle)
Description:
Releases the handle of an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
int32_t SpiGetCfg (struct [DevHandle](DevHandle.md) * handle, struct [SpiCfg](SpiCfg.md) * cfg )
Description:
Obtains the configuration parameters of an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
| cfg | Indicates the pointer to the configuration parameters. |
Returns:
Returns 0 if the operation is successful; returns a negative value otherwise.
struct [DevHandle](DevHandle.md)* SpiOpen (const struct [SpiDevInfo](SpiDevInfo.md) * info)
Description:
Obtains the handle of an SPI device.
Parameters:
| info | Indicates the pointer to the SPI device information. |
Returns:
Returns the pointer to the handle of the SPI device if the operation is successful; returns NULL otherwise.
int32_t SpiRead (struct [DevHandle](DevHandle.md) * handle, uint8_t * buf, uint32_t len )
Description:
Reads data of a specified length from an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
| buf | Indicates the pointer to the buffer for receiving the data. |
| len | Indicates the length of the data to read. |
Returns:
Returns 0 if the operation is successful; returns a negative value otherwise.
int32_t SpiSetCfg (struct [DevHandle](DevHandle.md) * handle, struct [SpiCfg](SpiCfg.md) * cfg )
Description:
Sets configuration parameters for an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
| cfg | Indicates the pointer to the configuration parameters. |
Returns:
Returns 0 if the operation is successful; returns a negative value otherwise.
int32_t SpiTransfer (struct [DevHandle](DevHandle.md) * handle, struct [SpiMsg](SpiMsg.md) * msgs, uint32_t count )
Description:
Launches a custom transfer to an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
| msgs | Indicates the pointer to the data to transfer. |
| count | Indicates the length of the message structure array. |
Returns:
Returns 0 if the operation is successful; returns a negative value otherwise.
See also:
int32_t SpiWrite (struct [DevHandle](DevHandle.md) * handle, uint8_t * buf, uint32_t len )
Description:
Writes data of a specified length to an SPI device.
Parameters:
| handle | Indicates the pointer to the SPI device handle obtained via SpiOpen. |
| buf | Indicates the pointer to the data to write. |
| len | Indicates the length of the data to write. |
Returns:
Returns 0 if the operation is successful; returns a negative value otherwise.
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。