|
1 /* |
|
2 * spi_api.h |
|
3 * |
|
4 * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved. |
|
5 * All rights reserved. |
|
6 * |
|
7 * This program and the accompanying materials are made available under the |
|
8 * terms of the Eclipse Public License v1.0 or BSD License which accompanies |
|
9 * this distribution. The Eclipse Public License is available at |
|
10 * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below. |
|
11 * |
|
12 * Redistribution and use in source and binary forms, with or without |
|
13 * modification, are permitted provided that the following conditions |
|
14 * are met: |
|
15 * |
|
16 * * Redistributions of source code must retain the above copyright |
|
17 * notice, this list of conditions and the following disclaimer. |
|
18 * * Redistributions in binary form must reproduce the above copyright |
|
19 * notice, this list of conditions and the following disclaimer in |
|
20 * the documentation and/or other materials provided with the |
|
21 * distribution. |
|
22 * * Neither the name Texas Instruments nor the names of its |
|
23 * contributors may be used to endorse or promote products derived |
|
24 * from this software without specific prior written permission. |
|
25 * |
|
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
|
27 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
|
28 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
|
29 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
|
30 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
|
31 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
|
32 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
36 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
37 */ |
|
38 |
|
39 |
|
40 /* |
|
41 * inc/spi_api.h |
|
42 * |
|
43 * Header for SPI API test interface |
|
44 * |
|
45 * Copyright (C) 2006 Texas Instruments, Inc. |
|
46 * |
|
47 * Acknowledgements: |
|
48 * None |
|
49 * |
|
50 * This program is free software; you can redistribute it and/or modify it |
|
51 * under the terms of the GNU General Public License as published by the |
|
52 * Free Software Foundation version 2. |
|
53 * |
|
54 * This program is distributed “as is” WITHOUT ANY WARRANTY of any kind, |
|
55 * whether express or implied; without even the implied warranty of |
|
56 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
57 * General Public License for more details. |
|
58 */ |
|
59 |
|
60 #ifndef SPI_API_H |
|
61 #define SPI_API_H |
|
62 |
|
63 |
|
64 typedef void (*request_callback_t) (void *data, int status); |
|
65 |
|
66 |
|
67 typedef enum |
|
68 { |
|
69 SPI_OK = 0, |
|
70 SPI_TXN_COMPLETE = 0, |
|
71 SPI_TXN_PENDING = 1, |
|
72 SPI_ERR_UNKNOWN = -1, |
|
73 SPI_ERR_BUS_BUSY = -2, |
|
74 SPI_ERR_QUEUE_FULL = -3, |
|
75 SPI_ERR_ALLOC_MEM = -4, |
|
76 SPI_ERR_ASYNC_TIMEOUT = -5, |
|
77 SPI_ERR_WRONG_LENGTH = -6, |
|
78 |
|
79 } SPI_Status_e; |
|
80 |
|
81 |
|
82 void* SPI_Open (void* hOS); |
|
83 int SPI_Close (void* hSPI); |
|
84 int SPI_Write (void* hSPI, TI_UINT8 *data, TI_UINT32 length, request_callback_t fCb, void *pCb, int more); |
|
85 int SPI_Read (void* hSPI, TI_UINT8 *data, TI_UINT32 length, request_callback_t fCb, void *pCb, int more); |
|
86 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); |
|
87 int SPI_WriteSync (void* hSPI, TI_UINT8 *data, TI_UINT32 length, int more); |
|
88 int SPI_ReadSync (void* hSPI, TI_UINT8 *data, TI_UINT32 length); |
|
89 |
|
90 |
|
91 #endif /* SPI_API_H */ |
|
92 |