xref: /btstack/platform/embedded/hal_em9304_spi.h (revision 5e2dc9e820b2722f41a67c0977377abb07c1ebcf)
1 /*
2  * Copyright (C) 2014 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  *  hal_em9304_spi.h
40  *
41  *  Hardware Abstraction Layer for EM9304 connected via SPI with additional RDY Interrupt line
42  *
43  */
44 #ifndef __HAL_EM9304_SPI_H
45 #define __HAL_EM9304_SPI_H
46 
47 #include <stdint.h>
48 
49 #if defined __cplusplus
50 extern "C" {
51 #endif
52 
53 /* API_START */
54 
55 /**
56  * @brief Initialize SPI
57  */
58 void hal_em9304_spi_init(void);
59 
60 /**
61  * @brief Set callback for RDY - can be called from ISR context
62  * @param callback
63  */
64 void hal_em9304_spi_set_ready_callback(void (*callback)(void));
65 
66 /**
67  * @brief Set callback for transfer complete - can be called from ISR context
68  * @param callback
69  */
70 void hal_em9304_spi_set_transfer_done_callback(void (*callback)(void));
71 
72 /**
73  * @brief Enable READY IRQ
74  */
75 void hal_em9304_spi_enable_ready_interrupt(void);
76 
77 /**
78  * @brief Disable READY IRQ
79  */
80 void hal_em9304_spi_disable_ready_interrupt(void);
81 
82 /**
83  * @brief Poll READY state
84  */
85 int hal_em9304_spi_get_ready();
86 
87 /**
88  * @brief Set Chip Selet
89  * @param enable
90  */
91 void hal_em9304_spi_set_chip_select(int enable);
92 
93 /**
94  * @brief Check if full duplex operation via hal_em9304_spi_transceive is supported
95  */
96 int  hal_em9304_spi_fullduplex_support(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 hal_em9304_spi_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 hal_em9304_spi_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 hal_em9304_spi_receive(uint8_t * rx_data, uint16_t len);
119 
120 /* API_END */
121 
122 #if defined __cplusplus
123 }
124 #endif
125 
126 #endif // __HAL_EM9304_SPI_H
127