xref: /btstack/src/btstack_em9304_spi.h (revision 7dc86dfd3569d69491d87d64749fd45afb46c67a)
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 MATTHIAS
24  * RINGWALD 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  *  btstack_em9304_spi.h
40  *
41  *  BTstack's Hardware Abstraction Layer for EM9304 connected via SPI with additional RDY Interrupt line
42 
43  */
44 #ifndef __BTSTACK_EM9304_SPI_H
45 #define __BTSTACK_EM9304_SPI_H
46 
47 #include <stdint.h>
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 /* API_START */
54 
55 #include <stdint.h>
56 typedef struct {
57 
58     /* API_START */
59 
60     /**
61      * @brief Open SPI
62      */
63     int (*open)(void);
64 
65     /**
66      * @brief Close SPI
67      */
68     int (*close)(void);
69 
70     /**
71      * @brief Check if full duplex operation via transceive is supported
72      * @return 1 if supported
73      */
74     int  (*get_fullduplex_support)(void);
75 
76     /**
77      * @brief Set callback for RDY
78      * @param callback or NULL to disable callback
79      */
80     void (*set_ready_callback)(void (*callback)(void));
81 
82     /**
83      * @brief Set callback for transfer complete
84      * @param callback
85      */
86     void (*set_transfer_done_callback)(void (*callback)(void));
87 
88     /**
89      * @brief Set Chip Selet
90      * @param enable
91      */
92     void (*set_chip_select)(int enable);
93 
94     /**
95      * @brief Poll READY state
96      */
97     int (*get_ready)(void);
98 
99     /**
100      * @brief Transmit and Receive bytes via SPI
101      * @param tx_data buffer to transmit
102      * @param rx_data buffer to receive into
103      * @param len
104      */
105     void (*transceive)(const uint8_t * tx_data, uint8_t * rx_data, uint16_t len);
106 
107     /**
108      * @brief Transmit bytes via SPI
109      * @param tx_data buffer to transmit
110      * @param len
111      */
112     void (*transmit)(const uint8_t * tx_data, uint16_t len);
113 
114     /**
115      * @brief Receive bytes via SPI
116      * @param rx_data buffer to receive into
117      * @param len
118      */
119     void (*receive)(uint8_t * rx_data, uint16_t len);
120 
121 } btstack_em9304_spi_t;
122 
123 /**
124  *
125  */
126 const btstack_em9304_spi_t * btstack_em9304_spi_embedded_instance(void);
127 
128 #if defined __cplusplus
129 }
130 #endif
131 
132 #endif // __BTSTACK_EM9304_SPI_H
133