SDK4.0 This document shows Ameba SDK 4.0 APIs

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

spi_ex_api.h File Reference

This file provides following mbed SPI API. More...

`#include "device.h"`

## Ameba Common
#define | SPI_DMA_RX_EN (1<<0)
#define | SPI_DMA_TX_EN (1<<1)
#define | SPI_STATE_READY 0x00
#define | SPI_STATE_RX_BUSY (1<<1)
#define | SPI_STATE_TX_BUSY (1<<2)
enum | { SPI_SCLK_IDLE_LOW =0, SPI_SCLK_IDLE_HIGH =2 }
enum | { SPI_CS_TOGGLE_EVERY_FRAME =0, SPI_CS_TOGGLE_START_STOP =1 }
enum | { SPI_SCLK_TOGGLE_MIDDLE =0, SPI_SCLK_TOGGLE_START =1 }
enum | ChipSelect { CS_0 = 0, CS_1 = 1, CS_2 = 2, CS_3 = 3, CS_4 = 4, CS_5 = 5, CS_6 = 6, CS_7 = 7 }
enum | SpiIrq { SpiRxIrq, SpiTxIrq }
typedef void(* | spi_irq_handler) (uint32_t id, SpiIrq event)
void | spi_irq_hook (spi_t *obj, spi_irq_handler handler, uint32_t id)
| Set SPI interrupt handler if needed. More...
void | spi_bus_tx_done_irq_hook (spi_t *obj, spi_irq_handler handler, uint32_t id)
| Set SPI interrupt bus tx done handler if needed. More...
void | spi_slave_flush_fifo (spi_t *obj)
| Slave device to flush tx fifo. More...
int32_t | spi_slave_read_stream (spi_t *obj, char *rx_buffer, uint32_t length)
| slave recv target length data use interrupt mode. More...
int32_t | spi_slave_write_stream (spi_t *obj, char *tx_buffer, uint32_t length)
| slave send target length data use interrupt mode. More...
int32_t | spi_master_read_stream (spi_t *obj, char *rx_buffer, uint32_t length)
| master recv target length data use interrupt mode. More...
int32_t | spi_master_write_stream (spi_t *obj, char *tx_buffer, uint32_t length)
| master send target length data use interrupt mode. More...
int32_t | spi_master_write_read_stream (spi_t *obj, char *tx_buffer, char *rx_buffer, uint32_t length)
| master send & recv target length data use interrupt mode. More...
int32_t | spi_slave_read_stream_timeout (spi_t *obj, char *rx_buffer, uint32_t length, uint32_t timeout_ms)
| slave recv target length data use interrupt mode and timeout mechanism. More...
int32_t | spi_slave_read_stream_terminate (spi_t *obj, char *rx_buffer, uint32_t length)
| slave recv target length data use interrupt mode and stop if the spi bus is idle. More...
int32_t | spi_slave_read_stream_dma (spi_t *obj, char *rx_buffer, uint32_t length)
| slave recv target length data use DMA mode. More...
int32_t | spi_slave_write_stream_dma (spi_t *obj, char *tx_buffer, uint32_t length)
| slave send target length data use DMA mode. More...
int32_t | spi_master_write_read_stream_dma (spi_t *obj, char *tx_buffer, char *rx_buffer, uint32_t length)
| master send & recv target length data use DMA mode. More...
int32_t | spi_master_read_stream_dma (spi_t *obj, char *rx_buffer, uint32_t length)
| master recv target length data use DMA mode. More...
int32_t | spi_master_write_stream_dma (spi_t *obj, char *tx_buffer, uint32_t length)
| master send target length data use DMA mode. More...
int32_t | spi_slave_read_stream_dma_timeout (spi_t *obj, char *rx_buffer, uint32_t length, uint32_t timeout_ms)
| slave recv target length data use DMA mode and timeout mechanism. More...
int32_t | spi_slave_read_stream_dma_terminate (spi_t *obj, char *rx_buffer, uint32_t length)
| slave recv target length data use DMA mode and stop if the spi bus is idle. More...

## Detailed Description

This file provides following mbed SPI API.

mbed Microcontroller Library

Author

Version
  V1.0.0

Attention

Copyright (c) 2006-2013 ARM Limited

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.