1 /* 2 * spi_api.h 3 * 4 * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name Texas Instruments nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 35 /* 36 * inc/spi_api.h 37 * 38 * Header for SPI API test interface 39 * 40 */ 41 42 #ifndef SPI_API_H 43 #define SPI_API_H 44 45 46 typedef void (*request_callback_t) (void *data, int status); 47 48 49 typedef enum 50 { 51 SPI_OK = 0, 52 SPI_TXN_COMPLETE = 0, 53 SPI_TXN_PENDING = 1, 54 SPI_ERR_UNKNOWN = -1, 55 SPI_ERR_BUS_BUSY = -2, 56 SPI_ERR_QUEUE_FULL = -3, 57 SPI_ERR_ALLOC_MEM = -4, 58 SPI_ERR_ASYNC_TIMEOUT = -5, 59 SPI_ERR_WRONG_LENGTH = -6, 60 61 } SPI_Status_e; 62 63 64 void* SPI_Open (void* hOS); 65 int SPI_Close (void* hSPI); 66 int SPI_Write (void* hSPI, TI_UINT8 *data, TI_UINT32 length, request_callback_t fCb, void *pCb, int more); 67 int SPI_Read (void* hSPI, TI_UINT8 *data, TI_UINT32 length, request_callback_t fCb, void *pCb, int more); 68 int SPI_WriteRead (void* hSPI, TI_UINT8 *data, TI_UINT32 length, TI_UINT8 *rdata, TI_UINT32 rlength, request_callback_t fCb, void* pCb, int more); 69 int SPI_WriteSync (void* hSPI, TI_UINT8 *data, TI_UINT32 length, int more); 70 int SPI_ReadSync (void* hSPI, TI_UINT8 *data, TI_UINT32 length); 71 72 73 #endif /* SPI_API_H */ 74 75
