xref: /btstack/src/btstack_em9304_spi.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2017 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 /**
39  * @title EM9304 SPI
40  *
41  * BTstack's Hardware Abstraction Layer for EM9304 connected via SPI with additional RDY Interrupt line.
42  *
43  */
44 
45 #ifndef BTSTACK_EM9304_SPI_H
46 #define BTSTACK_EM9304_SPI_H
47 
48 #include <stdint.h>
49 
50 #if defined __cplusplus
51 extern "C" {
52 #endif
53 
54 /* API_START */
55 
56 #include <stdint.h>
57 typedef struct {
58 
59     /**
60      * @brief Open SPI
61      */
62     int (*open)(void);
63 
64     /**
65      * @brief Close SPI
66      */
67     int (*close)(void);
68 
69     /**
70      * @brief Check if full duplex operation via transceive is supported
71      * @return 1 if supported
72      */
73     int  (*get_fullduplex_support)(void);
74 
75     /**
76      * @brief Set callback for RDY
77      * @param callback or NULL to disable callback
78      */
79     void (*set_ready_callback)(void (*callback)(void));
80 
81     /**
82      * @brief Set callback for transfer complete
83      * @param callback
84      */
85     void (*set_transfer_done_callback)(void (*callback)(void));
86 
87     /**
88      * @brief Set Chip Selet
89      * @param enable
90      */
91     void (*set_chip_select)(int enable);
92 
93     /**
94      * @brief Poll READY state
95      */
96     int (*get_ready)(void);
97 
98     /**
99      * @brief Transmit and Receive bytes via SPI
100      * @param tx_data buffer to transmit
101      * @param rx_data buffer to receive into
102      * @param len
103      */
104     void (*transceive)(const uint8_t * tx_data, uint8_t * rx_data, uint16_t len);
105 
106     /**
107      * @brief Transmit bytes via SPI
108      * @param tx_data buffer to transmit
109      * @param len
110      */
111     void (*transmit)(const uint8_t * tx_data, uint16_t len);
112 
113     /**
114      * @brief Receive bytes via SPI
115      * @param rx_data buffer to receive into
116      * @param len
117      */
118     void (*receive)(uint8_t * rx_data, uint16_t len);
119 
120 } btstack_em9304_spi_t;
121 
122 /**
123  * @brief Get EM9304 SPI instance
124  */
125 const btstack_em9304_spi_t * btstack_em9304_spi_embedded_instance(void);
126 
127 /* API_END */
128 
129 #if defined __cplusplus
130 }
131 #endif
132 
133 #endif // BTSTACK_EM9304_SPI_H
134