ST / stm-spirit1-rf-driver

Prototype RF driver for STM Sub-1 GHz RF expansion board based on the SPSGRF-868 module for STM32 Nucleo.

Prototype RF Driver for STM Sub-1 GHz RF Expansion Boards based on the SPSGRF-868 and SPSGRF-915 Modules for STM32 Nucleo

Currently supported boards:

Note, in order to use expansion board X-NUCLEO-IDS01A4 in mbed you need to perform the following HW modifications on the board:

  • Unmount resistor R4
  • Mount resistor R7

Furthermore, on some Nucleo development boards (e.g. the NUCLEO_F429ZI), in order to be able to use Ethernet together with these Sub-1 GHz RF expansion boards, you need to compile this driver with macro SPIRIT1_SPI_MOSI=PB_5 defined, while the development board typically requires some HW modification as e.g. described here!

This driver can be used together with the 6LoWPAN stack (a.k.a. Nanostack).

SimpleSpirit1.h@23:4192649f35da, 2016-11-09 (annotated)

Committer:
Wolfgang Betz
Date:
Wed Nov 09 14:02:18 2016 +0100
Revision:
23:4192649f35da
Parent:
22:9165bd73c61e
Child:
24:03e351bfc9c9
Enable CSMA/CA

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Wolfgang Betz 0:4fb29d9ee571 1 /*** Mbed Includes ***/
Wolfgang Betz 0:4fb29d9ee571 2 #include "mbed.h"
Wolfgang Betz 22:9165bd73c61e 3 #include "mbed_debug.h"
Wolfgang Betz 0:4fb29d9ee571 4
Wolfgang Betz 0:4fb29d9ee571 5
Wolfgang Betz 0:4fb29d9ee571 6 /*** Cube Includes ***/
Wolfgang Betz 0:4fb29d9ee571 7 #include "SPIRIT_Radio.h"
Wolfgang Betz 0:4fb29d9ee571 8 #include "SPIRIT_Management.h"
Wolfgang Betz 0:4fb29d9ee571 9 #include "SPIRIT_Commands.h"
Wolfgang Betz 0:4fb29d9ee571 10 #include "MCU_Interface.h"
Wolfgang Betz 0:4fb29d9ee571 11
Wolfgang Betz 0:4fb29d9ee571 12
Wolfgang Betz 0:4fb29d9ee571 13 /*** Contiki Lib Includes ***/
Wolfgang Betz 0:4fb29d9ee571 14 #include "spirit1.h"
Wolfgang Betz 0:4fb29d9ee571 15 #include "spirit1-config.h"
Wolfgang Betz 0:4fb29d9ee571 16 #include "spirit1-const.h"
Wolfgang Betz 0:4fb29d9ee571 17
Wolfgang Betz 0:4fb29d9ee571 18
Wolfgang Betz 4:07537ca85c66 19 /*** Macros from Cube Implementation ***/
Wolfgang Betz 14:898a9d48dd03 20 #define CLEAR_TXBUF() (spirit_tx_len = 0)
Wolfgang Betz 14:898a9d48dd03 21 #define IS_RXBUF_EMPTY() (spirit_rx_len == 0)
Wolfgang Betz 14:898a9d48dd03 22 #define CLEAR_RXBUF() do { \
Wolfgang Betz 14:898a9d48dd03 23 spirit_rx_len = 0; \
Wolfgang Betz 14:898a9d48dd03 24 _spirit_rx_pos = 0; \
Wolfgang Betz 14:898a9d48dd03 25 } while(0)
Wolfgang Betz 14:898a9d48dd03 26
Wolfgang Betz 14:898a9d48dd03 27
Wolfgang Betz 14:898a9d48dd03 28 /*** Macros from Cube Implementation ***/
Wolfgang Betz 4:07537ca85c66 29 /* transceiver state. */
Wolfgang Betz 4:07537ca85c66 30 #define ON 0
Wolfgang Betz 4:07537ca85c66 31 #define OFF 1
Wolfgang Betz 4:07537ca85c66 32
Wolfgang Betz 4:07537ca85c66 33
Wolfgang Betz 0:4fb29d9ee571 34 /*** Missing Cube External Declarations ***/
Wolfgang Betz 0:4fb29d9ee571 35 extern "C" void SpiritManagementSetFrequencyBase(uint32_t);
Wolfgang Betz 0:4fb29d9ee571 36
Wolfgang Betz 0:4fb29d9ee571 37
Wolfgang Betz 7:e90fa8f6bc6c 38 /*** UnlockedSPI for Performance (due to singleton) ***/
Wolfgang Betz 7:e90fa8f6bc6c 39 class UnlockedSPI : public SPI {
Wolfgang Betz 7:e90fa8f6bc6c 40 public:
Wolfgang Betz 7:e90fa8f6bc6c 41 UnlockedSPI(PinName mosi, PinName miso, PinName sclk) :
Wolfgang Betz 7:e90fa8f6bc6c 42 SPI(mosi, miso, sclk) { }
Wolfgang Betz 7:e90fa8f6bc6c 43 virtual void lock() { }
Wolfgang Betz 7:e90fa8f6bc6c 44 virtual void unlock() { }
Wolfgang Betz 7:e90fa8f6bc6c 45 };
Wolfgang Betz 7:e90fa8f6bc6c 46
Wolfgang Betz 7:e90fa8f6bc6c 47
Wolfgang Betz 0:4fb29d9ee571 48 /*** A Simple Spirit1 Class ***/
Wolfgang Betz 9:3db68ab23070 49 // NOTE: must be a singleton (due to mix of MBED/CUBE code)!!!
Wolfgang Betz 9:3db68ab23070 50 // NOTE: implementation is IRQ-save but (intentionally) NOT thread-safe!!!
Wolfgang Betz 9:3db68ab23070 51 class SimpleSpirit1 {
Wolfgang Betz 0:4fb29d9ee571 52 protected:
Wolfgang Betz 0:4fb29d9ee571 53 static SimpleSpirit1 *_singleton;
Wolfgang Betz 0:4fb29d9ee571 54
Wolfgang Betz 0:4fb29d9ee571 55 /** Communication Interface Instance Variables **/
Wolfgang Betz 7:e90fa8f6bc6c 56 UnlockedSPI _spi; // betzw - NOTE: Arduino pins are valid only for NUCLEO-F401RE
Wolfgang Betz 7:e90fa8f6bc6c 57 // mosi: PA_7 (D11)
Wolfgang Betz 7:e90fa8f6bc6c 58 // miso: PA_6 (D12)
Wolfgang Betz 7:e90fa8f6bc6c 59 // sclk: PB_3 (D3) or
Wolfgang Betz 7:e90fa8f6bc6c 60 // PA_5 (D13) (only in case you unmount R4 & mount R7,
Wolfgang Betz 7:e90fa8f6bc6c 61 // (note: in this case you may not use LED1 on some platforms)
Wolfgang Betz 7:e90fa8f6bc6c 62 // bits: 8-bit
Wolfgang Betz 7:e90fa8f6bc6c 63 // mode: 0
Wolfgang Betz 7:e90fa8f6bc6c 64 // ordr: MSB
Wolfgang Betz 7:e90fa8f6bc6c 65 // freq: max 10MHz
Wolfgang Betz 2:45642c5198a2 66 InterruptIn _irq; // PC_7 (D9) (falling)
Wolfgang Betz 2:45642c5198a2 67 DigitalOut _chip_select; // PB_6 (D10) ('1' == chip unselected)
Wolfgang Betz 2:45642c5198a2 68 DigitalOut _shut_down; // PA_10 (D2) ('1' == shut_down)
Wolfgang Betz 2:45642c5198a2 69 DigitalOut _led; // PB_4 (D5) (optional)
Wolfgang Betz 0:4fb29d9ee571 70
Wolfgang Betz 7:e90fa8f6bc6c 71 Callback<void(int)> _current_irq_callback;
Wolfgang Betz 14:898a9d48dd03 72 Timeout _rx_receiving_timeout;
Wolfgang Betz 14:898a9d48dd03 73
Wolfgang Betz 14:898a9d48dd03 74 void rx_timeout_handler(void) {
Wolfgang Betz 14:898a9d48dd03 75 set_ready_state();
Wolfgang Betz 14:898a9d48dd03 76 cmd_strobe(SPIRIT1_STROBE_FRX);
Wolfgang Betz 14:898a9d48dd03 77 cmd_strobe(SPIRIT1_STROBE_RX);
Wolfgang Betz 14:898a9d48dd03 78 CLEAR_TXBUF();
Wolfgang Betz 14:898a9d48dd03 79 CLEAR_RXBUF();
Wolfgang Betz 14:898a9d48dd03 80 _spirit_rx_err = false;
Wolfgang Betz 14:898a9d48dd03 81 _spirit_tx_started = false;
Wolfgang Betz 22:9165bd73c61e 82 #ifndef NDEBUG
Wolfgang Betz 22:9165bd73c61e 83 debug("\n\r%s (%d)\n\r", __func__, __LINE__);
Wolfgang Betz 22:9165bd73c61e 84 #endif
Wolfgang Betz 14:898a9d48dd03 85 }
Wolfgang Betz 14:898a9d48dd03 86
Wolfgang Betz 14:898a9d48dd03 87 void start_rx_timeout(void) {
Wolfgang Betz 14:898a9d48dd03 88 _rx_receiving_timeout.attach_us(Callback<void()>(this, &SimpleSpirit1::rx_timeout_handler), 500 * 1000); // 5ms
Wolfgang Betz 14:898a9d48dd03 89 }
Wolfgang Betz 14:898a9d48dd03 90
Wolfgang Betz 14:898a9d48dd03 91 void stop_rx_timeout(void) {
Wolfgang Betz 14:898a9d48dd03 92 _rx_receiving_timeout.detach();
Wolfgang Betz 14:898a9d48dd03 93 }
Wolfgang Betz 3:0df38cfb1e53 94
Wolfgang Betz 0:4fb29d9ee571 95 /** Static Variables from Cube Implementation **/
Wolfgang Betz 0:4fb29d9ee571 96 /*
Wolfgang Betz 0:4fb29d9ee571 97 * The buffers which hold incoming data.
Wolfgang Betz 0:4fb29d9ee571 98 * The +1 because of the first byte,
Wolfgang Betz 0:4fb29d9ee571 99 * which will contain the length of the packet.
Wolfgang Betz 0:4fb29d9ee571 100 */
Wolfgang Betz 12:b8056eda4028 101 volatile uint16_t spirit_tx_len;
Wolfgang Betz 12:b8056eda4028 102 volatile bool _spirit_tx_started;
Wolfgang Betz 12:b8056eda4028 103 volatile uint16_t spirit_rx_len;
Wolfgang Betz 12:b8056eda4028 104 volatile uint16_t _spirit_rx_pos;
Wolfgang Betz 12:b8056eda4028 105 volatile bool _spirit_rx_err;
Wolfgang Betz 6:f5d01793bf86 106 uint8_t spirit_rx_buf[MAX_PACKET_LEN];
Wolfgang Betz 12:b8056eda4028 107 volatile bool _is_receiving;
Wolfgang Betz 6:f5d01793bf86 108
Wolfgang Betz 6:f5d01793bf86 109 /** Status Variables from Cube Implementation **/
Wolfgang Betz 12:b8056eda4028 110 unsigned int spirit_on;
Wolfgang Betz 8:10967c884e38 111 uint8_t last_rssi; //MGR
Wolfgang Betz 8:10967c884e38 112 uint8_t last_lqi; //MGR
Wolfgang Betz 0:4fb29d9ee571 113
Wolfgang Betz 0:4fb29d9ee571 114 /** Low Level Instance Variables **/
Wolfgang Betz 0:4fb29d9ee571 115 unsigned int _nr_of_irq_disables;
Wolfgang Betz 0:4fb29d9ee571 116
Wolfgang Betz 3:0df38cfb1e53 117 /** Low Level Instance Methods **/
Wolfgang Betz 4:07537ca85c66 118 void disable_spirit_irq(void) {
Wolfgang Betz 0:4fb29d9ee571 119 _irq.disable_irq();
Wolfgang Betz 0:4fb29d9ee571 120 _nr_of_irq_disables++;
Wolfgang Betz 22:9165bd73c61e 121 #ifndef NDEBUG
Wolfgang Betz 22:9165bd73c61e 122 debug_if(_nr_of_irq_disables == 0, "\n\rassert failed in: %s (%d)\n\r", __func__, __LINE__);
Wolfgang Betz 22:9165bd73c61e 123 #endif
Wolfgang Betz 0:4fb29d9ee571 124 }
Wolfgang Betz 0:4fb29d9ee571 125
Wolfgang Betz 4:07537ca85c66 126 void enable_spirit_irq(void) {
Wolfgang Betz 22:9165bd73c61e 127 #ifndef NDEBUG
Wolfgang Betz 22:9165bd73c61e 128 debug_if(_nr_of_irq_disables == 0, "\n\rassert failed in: %s (%d)\n\r", __func__, __LINE__);
Wolfgang Betz 22:9165bd73c61e 129 #endif
Wolfgang Betz 0:4fb29d9ee571 130 if(--_nr_of_irq_disables == 0)
Wolfgang Betz 0:4fb29d9ee571 131 _irq.enable_irq();
Wolfgang Betz 0:4fb29d9ee571 132 }
Wolfgang Betz 0:4fb29d9ee571 133
Wolfgang Betz 0:4fb29d9ee571 134 void chip_select() { _chip_select = 0; }
Wolfgang Betz 0:4fb29d9ee571 135 void chip_unselect() { _chip_select = 1; }
Wolfgang Betz 0:4fb29d9ee571 136
Wolfgang Betz 0:4fb29d9ee571 137 void enter_shutdown() { _shut_down = 1; }
Wolfgang Betz 0:4fb29d9ee571 138 void exit_shutdown() {
Wolfgang Betz 0:4fb29d9ee571 139 _shut_down = 0;
Wolfgang Betz 0:4fb29d9ee571 140 wait_ms(2); // wait two milliseconds (to allow Spirit1 a proper boot-up sequence)
Wolfgang Betz 0:4fb29d9ee571 141 }
Wolfgang Betz 0:4fb29d9ee571 142
Wolfgang Betz 0:4fb29d9ee571 143 void cs_to_sclk_delay(void) {
Wolfgang Betz 0:4fb29d9ee571 144 wait_us(1); // heuristic value
Wolfgang Betz 0:4fb29d9ee571 145 }
Wolfgang Betz 0:4fb29d9ee571 146
Wolfgang Betz 3:0df38cfb1e53 147 /**
Wolfgang Betz 3:0df38cfb1e53 148 * @brief Write and read a buffer to/from the SPI peripheral device at the same time
Wolfgang Betz 3:0df38cfb1e53 149 * in 8-bit data mode using synchronous SPI communication.
Wolfgang Betz 3:0df38cfb1e53 150 * @param[in] pBufferToWrite pointer to the buffer of data to send.
Wolfgang Betz 3:0df38cfb1e53 151 * @param[out] pBufferToRead pointer to the buffer to read data into.
Wolfgang Betz 3:0df38cfb1e53 152 * @param[in] NumBytes number of bytes to read and write.
Wolfgang Betz 3:0df38cfb1e53 153 * @retval 0 if ok.
Wolfgang Betz 3:0df38cfb1e53 154 * @retval -1 if data format error.
Wolfgang Betz 3:0df38cfb1e53 155 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
Wolfgang Betz 3:0df38cfb1e53 156 * before calling this function and to enable them again after.
Wolfgang Betz 3:0df38cfb1e53 157 */
Wolfgang Betz 3:0df38cfb1e53 158 void spi_write_read(uint8_t* pBufferToWrite, uint8_t* pBufferToRead, uint16_t NumBytes)
Wolfgang Betz 3:0df38cfb1e53 159 {
Wolfgang Betz 3:0df38cfb1e53 160 /* Read and write data at the same time. */
Wolfgang Betz 3:0df38cfb1e53 161 for (int i = 0; i < NumBytes; i++) {
Wolfgang Betz 3:0df38cfb1e53 162 pBufferToRead[i] = _spi.write(pBufferToWrite[i]);
Wolfgang Betz 3:0df38cfb1e53 163 }
Wolfgang Betz 3:0df38cfb1e53 164 }
Wolfgang Betz 3:0df38cfb1e53 165
Wolfgang Betz 0:4fb29d9ee571 166 /** Radio Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 167 void radio_set_xtal_freq(uint32_t freq) {
Wolfgang Betz 0:4fb29d9ee571 168 SpiritRadioSetXtalFrequency(freq);
Wolfgang Betz 0:4fb29d9ee571 169 }
Wolfgang Betz 0:4fb29d9ee571 170
Wolfgang Betz 0:4fb29d9ee571 171 void radio_set_pa_level_dbm(uint8_t cIndex, float fPowerdBm) {
Wolfgang Betz 0:4fb29d9ee571 172 SpiritRadioSetPALeveldBm(cIndex, fPowerdBm);
Wolfgang Betz 0:4fb29d9ee571 173 }
Wolfgang Betz 0:4fb29d9ee571 174
Wolfgang Betz 0:4fb29d9ee571 175 void radio_set_pa_level_max_index(uint8_t cIndex) {
Wolfgang Betz 0:4fb29d9ee571 176 SpiritRadioSetPALevelMaxIndex(cIndex);
Wolfgang Betz 0:4fb29d9ee571 177 }
Wolfgang Betz 0:4fb29d9ee571 178
Wolfgang Betz 0:4fb29d9ee571 179 uint8_t radio_init(SRadioInit *init_struct) {
Wolfgang Betz 0:4fb29d9ee571 180 return SpiritRadioInit(init_struct);
Wolfgang Betz 0:4fb29d9ee571 181 }
Wolfgang Betz 3:0df38cfb1e53 182
Wolfgang Betz 0:4fb29d9ee571 183 void radio_persisten_rx(SpiritFunctionalState xNewState) {
Wolfgang Betz 0:4fb29d9ee571 184 SpiritRadioPersistenRx(xNewState);
Wolfgang Betz 0:4fb29d9ee571 185 }
Wolfgang Betz 0:4fb29d9ee571 186
Wolfgang Betz 0:4fb29d9ee571 187 void radio_afc_freeze_on_sync(SpiritFunctionalState xNewState) {
Wolfgang Betz 0:4fb29d9ee571 188 SpiritRadioAFCFreezeOnSync(xNewState);
Wolfgang Betz 0:4fb29d9ee571 189 }
Wolfgang Betz 0:4fb29d9ee571 190
Wolfgang Betz 0:4fb29d9ee571 191 /** Packet System Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 192 void pkt_basic_init(PktBasicInit* pxPktBasicInit) {
Wolfgang Betz 0:4fb29d9ee571 193 SpiritPktBasicInit(pxPktBasicInit);
Wolfgang Betz 0:4fb29d9ee571 194 }
Wolfgang Betz 0:4fb29d9ee571 195
Wolfgang Betz 3:0df38cfb1e53 196 void pkt_basic_set_payload_length(uint16_t nPayloadLength) {
Wolfgang Betz 3:0df38cfb1e53 197 SpiritPktBasicSetPayloadLength(nPayloadLength);
Wolfgang Betz 3:0df38cfb1e53 198 }
Wolfgang Betz 3:0df38cfb1e53 199
Wolfgang Betz 4:07537ca85c66 200 uint16_t pkt_basic_get_received_pkt_length(void) {
Wolfgang Betz 4:07537ca85c66 201 return SpiritPktBasicGetReceivedPktLength();
Wolfgang Betz 4:07537ca85c66 202 }
Wolfgang Betz 4:07537ca85c66 203
Wolfgang Betz 3:0df38cfb1e53 204 /** IRQ Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 205 void irq_de_init(SpiritIrqs* pxIrqInit) {
Wolfgang Betz 0:4fb29d9ee571 206 SpiritIrqDeInit(pxIrqInit);
Wolfgang Betz 0:4fb29d9ee571 207 }
Wolfgang Betz 0:4fb29d9ee571 208
Wolfgang Betz 0:4fb29d9ee571 209 void irq_clear_status(void) {
Wolfgang Betz 0:4fb29d9ee571 210 SpiritIrqClearStatus();
Wolfgang Betz 0:4fb29d9ee571 211 }
Wolfgang Betz 0:4fb29d9ee571 212
Wolfgang Betz 0:4fb29d9ee571 213 void irq_set_status(IrqList xIrq, SpiritFunctionalState xNewState) {
Wolfgang Betz 0:4fb29d9ee571 214 SpiritIrq(xIrq, xNewState);
Wolfgang Betz 0:4fb29d9ee571 215 }
Wolfgang Betz 0:4fb29d9ee571 216
Wolfgang Betz 4:07537ca85c66 217 void irq_get_status(SpiritIrqs* pxIrqStatus) {
Wolfgang Betz 4:07537ca85c66 218 SpiritIrqGetStatus(pxIrqStatus);
Wolfgang Betz 4:07537ca85c66 219 }
Wolfgang Betz 4:07537ca85c66 220
Wolfgang Betz 0:4fb29d9ee571 221 /** Management Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 222 void mgmt_set_freq_base(uint32_t freq) {
Wolfgang Betz 0:4fb29d9ee571 223 SpiritManagementSetFrequencyBase(freq);
Wolfgang Betz 0:4fb29d9ee571 224 }
Wolfgang Betz 0:4fb29d9ee571 225
Wolfgang Betz 4:07537ca85c66 226 void mgmt_refresh_status(void) {
Wolfgang Betz 4:07537ca85c66 227 SpiritRefreshStatus();
Wolfgang Betz 4:07537ca85c66 228 }
Wolfgang Betz 4:07537ca85c66 229
Wolfgang Betz 0:4fb29d9ee571 230 /** Spirit GPIO Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 231 void spirit_gpio_init(SGpioInit* pxGpioInitStruct) {
Wolfgang Betz 0:4fb29d9ee571 232 SpiritGpioInit(pxGpioInitStruct);
Wolfgang Betz 0:4fb29d9ee571 233 }
Wolfgang Betz 0:4fb29d9ee571 234
Wolfgang Betz 0:4fb29d9ee571 235 /** Qi Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 236 void qi_set_sqi_threshold(SqiThreshold xSqiThr) {
Wolfgang Betz 0:4fb29d9ee571 237 SpiritQiSetSqiThreshold(xSqiThr);
Wolfgang Betz 0:4fb29d9ee571 238 }
Wolfgang Betz 0:4fb29d9ee571 239
Wolfgang Betz 0:4fb29d9ee571 240 void qi_sqi_check(SpiritFunctionalState xNewState) {
Wolfgang Betz 0:4fb29d9ee571 241 SpiritQiSqiCheck(xNewState);
Wolfgang Betz 0:4fb29d9ee571 242 }
Wolfgang Betz 0:4fb29d9ee571 243
Wolfgang Betz 0:4fb29d9ee571 244 void qi_set_rssi_threshold_dbm(int nDbmValue) {
Wolfgang Betz 0:4fb29d9ee571 245 SpiritQiSetRssiThresholddBm(nDbmValue);
Wolfgang Betz 0:4fb29d9ee571 246 }
Wolfgang Betz 0:4fb29d9ee571 247
Wolfgang Betz 4:07537ca85c66 248 float qi_get_rssi_dbm() {
Wolfgang Betz 8:10967c884e38 249 last_rssi = qi_get_rssi();
Wolfgang Betz 8:10967c884e38 250 return get_last_rssi_dbm();
Wolfgang Betz 4:07537ca85c66 251 }
Wolfgang Betz 4:07537ca85c66 252
Wolfgang Betz 4:07537ca85c66 253 uint8_t qi_get_rssi() {
Wolfgang Betz 4:07537ca85c66 254 return SpiritQiGetRssi();
Wolfgang Betz 4:07537ca85c66 255 }
Wolfgang Betz 4:07537ca85c66 256
Wolfgang Betz 4:07537ca85c66 257 uint8_t qi_get_lqi() {
Wolfgang Betz 4:07537ca85c66 258 return SpiritQiGetLqi();
Wolfgang Betz 4:07537ca85c66 259 }
Wolfgang Betz 4:07537ca85c66 260
Wolfgang Betz 0:4fb29d9ee571 261 /** Timer Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 262 void timer_set_rx_timeout_stop_condition(RxTimeoutStopCondition xStopCondition) {
Wolfgang Betz 0:4fb29d9ee571 263 SpiritTimerSetRxTimeoutStopCondition(xStopCondition);
Wolfgang Betz 0:4fb29d9ee571 264 }
Wolfgang Betz 0:4fb29d9ee571 265
Wolfgang Betz 0:4fb29d9ee571 266 void timer_set_rx_timeout_counter(uint8_t cCounter) {
Wolfgang Betz 0:4fb29d9ee571 267 SpiritTimerSetRxTimeoutCounter(cCounter);
Wolfgang Betz 0:4fb29d9ee571 268 }
Wolfgang Betz 0:4fb29d9ee571 269
Wolfgang Betz 0:4fb29d9ee571 270 void timer_set_infinite_rx_timeout(void) {
Wolfgang Betz 0:4fb29d9ee571 271 timer_set_rx_timeout_counter(0);
Wolfgang Betz 0:4fb29d9ee571 272 }
Wolfgang Betz 0:4fb29d9ee571 273
Wolfgang Betz 23:4192649f35da 274 /** CSMA/CA Instance Methods **/
Wolfgang Betz 23:4192649f35da 275 void csma_ca_state(SpiritFunctionalState xNewState) {
Wolfgang Betz 23:4192649f35da 276 SpiritCsma(xNewState);
Wolfgang Betz 23:4192649f35da 277 }
Wolfgang Betz 23:4192649f35da 278
Wolfgang Betz 23:4192649f35da 279 void csma_ca_init(CsmaInit* pxCsmaInit) {
Wolfgang Betz 23:4192649f35da 280 csma_ca_state(S_DISABLE); // Disabled at init
Wolfgang Betz 23:4192649f35da 281 SpiritCsmaInit(pxCsmaInit);
Wolfgang Betz 23:4192649f35da 282 SpiritCsmaSeedReloadMode(S_DISABLE); // always disable seed reload
Wolfgang Betz 23:4192649f35da 283 }
Wolfgang Betz 23:4192649f35da 284
Wolfgang Betz 0:4fb29d9ee571 285 /** Command Instance Methods**/
Wolfgang Betz 4:07537ca85c66 286 void cmd_strobe(uint8_t cmd) {
Wolfgang Betz 0:4fb29d9ee571 287 SpiritCmdStrobeCommand((SpiritCmd)cmd);
Wolfgang Betz 0:4fb29d9ee571 288 }
Wolfgang Betz 0:4fb29d9ee571 289
Wolfgang Betz 4:07537ca85c66 290 void cmd_strobe_flush_rx_fifo() {
Wolfgang Betz 4:07537ca85c66 291 SpiritCmdStrobeCommand(CMD_FLUSHRXFIFO);
Wolfgang Betz 4:07537ca85c66 292 }
Wolfgang Betz 4:07537ca85c66 293
Wolfgang Betz 3:0df38cfb1e53 294 /** SPI Instance Methods **/
Wolfgang Betz 3:0df38cfb1e53 295 StatusBytes spi_write_linear_fifo(uint8_t cNbBytes, uint8_t* pcBuffer) {
Wolfgang Betz 3:0df38cfb1e53 296 return SdkEvalSpiWriteFifo(cNbBytes, pcBuffer);
Wolfgang Betz 3:0df38cfb1e53 297 }
Wolfgang Betz 3:0df38cfb1e53 298
Wolfgang Betz 4:07537ca85c66 299 StatusBytes spi_read_linear_fifo(uint8_t cNbBytes, uint8_t* pcBuffer) {
Wolfgang Betz 4:07537ca85c66 300 return SdkEvalSpiReadFifo(cNbBytes, pcBuffer);
Wolfgang Betz 4:07537ca85c66 301 }
Wolfgang Betz 4:07537ca85c66 302
Wolfgang Betz 4:07537ca85c66 303 /** Linear FIFO Instance Methods **/
Wolfgang Betz 4:07537ca85c66 304 uint8_t linear_fifo_read_num_elements_rx_fifo(void) {
Wolfgang Betz 4:07537ca85c66 305 return SpiritLinearFifoReadNumElementsRxFifo();
Wolfgang Betz 4:07537ca85c66 306 }
Wolfgang Betz 4:07537ca85c66 307
Wolfgang Betz 5:c9c5bc673c64 308 uint8_t linear_fifo_read_num_elements_tx_fifo(void) {
Wolfgang Betz 5:c9c5bc673c64 309 return SpiritLinearFifoReadNumElementsTxFifo();
Wolfgang Betz 5:c9c5bc673c64 310 }
Wolfgang Betz 5:c9c5bc673c64 311
Wolfgang Betz 16:25dc4b811ad3 312 void linear_fifo_set_almost_full_thr_rx(uint8_t cThrRxFifo) {
Wolfgang Betz 16:25dc4b811ad3 313 SpiritLinearFifoSetAlmostFullThresholdRx(cThrRxFifo);
Wolfgang Betz 16:25dc4b811ad3 314 }
Wolfgang Betz 16:25dc4b811ad3 315
Wolfgang Betz 3:0df38cfb1e53 316 /** Internal Spirit Methods */
Wolfgang Betz 3:0df38cfb1e53 317 void set_ready_state(void);
Wolfgang Betz 3:0df38cfb1e53 318 uint16_t arch_refresh_status(void);
Wolfgang Betz 3:0df38cfb1e53 319
Wolfgang Betz 0:4fb29d9ee571 320 /** Friend Functions **/
Wolfgang Betz 0:4fb29d9ee571 321 friend StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 322 friend StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 323 friend StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
Wolfgang Betz 0:4fb29d9ee571 324 friend StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 325 friend StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 326
Wolfgang Betz 0:4fb29d9ee571 327 /** Sdk Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 328 StatusBytes SdkEvalSpiWriteRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 329 StatusBytes SdkEvalSpiReadRegisters(uint8_t cRegAddress, uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 330 StatusBytes SdkEvalSpiCommandStrobes(uint8_t cCommandCode);
Wolfgang Betz 0:4fb29d9ee571 331 StatusBytes SdkEvalSpiWriteFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 332 StatusBytes SdkEvalSpiReadFifo(uint8_t cNbBytes, uint8_t* pcBuffer);
Wolfgang Betz 0:4fb29d9ee571 333
Wolfgang Betz 0:4fb29d9ee571 334 /** Helper Instance Methods **/
Wolfgang Betz 0:4fb29d9ee571 335 void chip_sync_select() {
Wolfgang Betz 4:07537ca85c66 336 disable_spirit_irq();
Wolfgang Betz 0:4fb29d9ee571 337 chip_select();
Wolfgang Betz 0:4fb29d9ee571 338 cs_to_sclk_delay();
Wolfgang Betz 0:4fb29d9ee571 339 }
Wolfgang Betz 0:4fb29d9ee571 340
Wolfgang Betz 0:4fb29d9ee571 341 void chip_sync_unselect() {
Wolfgang Betz 0:4fb29d9ee571 342 chip_unselect();
Wolfgang Betz 4:07537ca85c66 343 enable_spirit_irq();
Wolfgang Betz 0:4fb29d9ee571 344 }
Wolfgang Betz 0:4fb29d9ee571 345
Wolfgang Betz 2:45642c5198a2 346 /** Init Instance Method **/
Wolfgang Betz 2:45642c5198a2 347 void init(void);
Wolfgang Betz 2:45642c5198a2 348
Wolfgang Betz 5:c9c5bc673c64 349 /** Spirit Irq Callback */
Wolfgang Betz 5:c9c5bc673c64 350 void IrqHandler();
Wolfgang Betz 5:c9c5bc673c64 351
Wolfgang Betz 0:4fb29d9ee571 352 /** Constructor **/
Wolfgang Betz 0:4fb29d9ee571 353 SimpleSpirit1(PinName mosi, PinName miso, PinName sclk,
Wolfgang Betz 0:4fb29d9ee571 354 PinName irq, PinName cs, PinName sdn,
Wolfgang Betz 0:4fb29d9ee571 355 PinName led);
Wolfgang Betz 0:4fb29d9ee571 356
Wolfgang Betz 0:4fb29d9ee571 357 /** Destructor **/
Wolfgang Betz 0:4fb29d9ee571 358 ~SimpleSpirit1(void); // should never be called!
Wolfgang Betz 0:4fb29d9ee571 359
Wolfgang Betz 0:4fb29d9ee571 360 public:
Wolfgang Betz 9:3db68ab23070 361 enum {
Wolfgang Betz 9:3db68ab23070 362 RX_DONE,
Wolfgang Betz 9:3db68ab23070 363 TX_DONE,
Wolfgang Betz 9:3db68ab23070 364 TX_ERR
Wolfgang Betz 9:3db68ab23070 365 };
Wolfgang Betz 9:3db68ab23070 366
Wolfgang Betz 0:4fb29d9ee571 367 static SimpleSpirit1& CreateInstance(PinName mosi, PinName miso, PinName sclk,
Wolfgang Betz 0:4fb29d9ee571 368 PinName irq, PinName cs, PinName sdn,
Wolfgang Betz 0:4fb29d9ee571 369 PinName led = NC) {
Wolfgang Betz 0:4fb29d9ee571 370
Wolfgang Betz 0:4fb29d9ee571 371 if(_singleton == NULL) {
Wolfgang Betz 0:4fb29d9ee571 372 _singleton = new SimpleSpirit1(mosi, miso, sclk,
Wolfgang Betz 0:4fb29d9ee571 373 irq, cs, sdn, led);
Wolfgang Betz 2:45642c5198a2 374 _singleton->init();
Wolfgang Betz 0:4fb29d9ee571 375 } else {
Wolfgang Betz 2:45642c5198a2 376 error("SimpleSpirit1 singleton already created!\n");
Wolfgang Betz 0:4fb29d9ee571 377 }
Wolfgang Betz 0:4fb29d9ee571 378
Wolfgang Betz 0:4fb29d9ee571 379 return *_singleton;
Wolfgang Betz 0:4fb29d9ee571 380 }
Wolfgang Betz 0:4fb29d9ee571 381
Wolfgang Betz 0:4fb29d9ee571 382 static SimpleSpirit1& Instance() {
Wolfgang Betz 0:4fb29d9ee571 383 if(_singleton == NULL) {
Wolfgang Betz 2:45642c5198a2 384 error("SimpleSpirit1 must be created before used!\n");
Wolfgang Betz 0:4fb29d9ee571 385 }
Wolfgang Betz 0:4fb29d9ee571 386
Wolfgang Betz 0:4fb29d9ee571 387 return *_singleton;
Wolfgang Betz 0:4fb29d9ee571 388 }
Wolfgang Betz 0:4fb29d9ee571 389
Wolfgang Betz 6:f5d01793bf86 390 /** Attach a function to be called by the Spirit Irq handler when packet has arrived
Wolfgang Betz 0:4fb29d9ee571 391 *
Wolfgang Betz 3:0df38cfb1e53 392 * @param func A void() callback, or 0 to set as none
Wolfgang Betz 0:4fb29d9ee571 393 *
Wolfgang Betz 0:4fb29d9ee571 394 * @note Function 'func' will be executed in interrupt context!
Wolfgang Betz 0:4fb29d9ee571 395 */
Wolfgang Betz 7:e90fa8f6bc6c 396 void attach_irq_callback(Callback<void(int)> func) {
Wolfgang Betz 4:07537ca85c66 397 _current_irq_callback = func;
Wolfgang Betz 0:4fb29d9ee571 398 }
Wolfgang Betz 3:0df38cfb1e53 399
Wolfgang Betz 4:07537ca85c66 400 /** Switch Radio On/Off **/
Wolfgang Betz 4:07537ca85c66 401 int on(void);
Wolfgang Betz 4:07537ca85c66 402 int off(void);
Wolfgang Betz 4:07537ca85c66 403
Wolfgang Betz 8:10967c884e38 404 /** Set Channel **/
Wolfgang Betz 8:10967c884e38 405 void set_channel(uint8_t channel) {
Wolfgang Betz 8:10967c884e38 406 SpiritRadioSetChannel(channel);
Wolfgang Betz 8:10967c884e38 407 }
Wolfgang Betz 8:10967c884e38 408
Wolfgang Betz 7:e90fa8f6bc6c 409 /** Send a Buffer **/
Wolfgang Betz 6:f5d01793bf86 410 int send(const void *payload, unsigned int payload_len);
Wolfgang Betz 5:c9c5bc673c64 411
Wolfgang Betz 4:07537ca85c66 412 /** Read into Buffer **/
Wolfgang Betz 6:f5d01793bf86 413 int read(void *buf, unsigned int bufsize);
Wolfgang Betz 4:07537ca85c66 414
Wolfgang Betz 4:07537ca85c66 415 /** Perform a Clear-Channel Assessment (CCA) to find out if there is
Wolfgang Betz 4:07537ca85c66 416 a packet in the air or not.
Wolfgang Betz 23:4192649f35da 417 Returns 1 if packet has been seen.
Wolfgang Betz 4:07537ca85c66 418 */
Wolfgang Betz 4:07537ca85c66 419 int channel_clear(void);
Wolfgang Betz 4:07537ca85c66 420
Wolfgang Betz 4:07537ca85c66 421 /** Check if the radio driver has just received a packet **/
Wolfgang Betz 7:e90fa8f6bc6c 422 int get_pending_packet(void);
Wolfgang Betz 7:e90fa8f6bc6c 423
Wolfgang Betz 12:b8056eda4028 424 /** Is radio currently receiving **/
Wolfgang Betz 12:b8056eda4028 425 bool is_receiving(void) {
Wolfgang Betz 12:b8056eda4028 426 return _is_receiving;
Wolfgang Betz 12:b8056eda4028 427 }
Wolfgang Betz 12:b8056eda4028 428
Wolfgang Betz 7:e90fa8f6bc6c 429 /** Get latest value of RSSI **/
Wolfgang Betz 8:10967c884e38 430 float get_last_rssi_dbm(void) {
Wolfgang Betz 11:b769d6caad82 431 if(last_rssi == 0) {
Wolfgang Betz 11:b769d6caad82 432 last_rssi = qi_get_rssi();
Wolfgang Betz 11:b769d6caad82 433 }
Wolfgang Betz 8:10967c884e38 434 return (-120.0+((float)(last_rssi-20))/2);
Wolfgang Betz 7:e90fa8f6bc6c 435 }
Wolfgang Betz 7:e90fa8f6bc6c 436
Wolfgang Betz 7:e90fa8f6bc6c 437 /** Get latest value of LQI **/
Wolfgang Betz 8:10967c884e38 438 uint8_t get_last_lqi(void) {
Wolfgang Betz 11:b769d6caad82 439 if(last_lqi == 0) {
Wolfgang Betz 11:b769d6caad82 440 last_lqi = qi_get_lqi();
Wolfgang Betz 11:b769d6caad82 441 }
Wolfgang Betz 7:e90fa8f6bc6c 442 return last_lqi;
Wolfgang Betz 7:e90fa8f6bc6c 443 }
Wolfgang Betz 9:3db68ab23070 444
Wolfgang Betz 9:3db68ab23070 445 /** Reset Board **/
Wolfgang Betz 9:3db68ab23070 446 void reset_board(void) {
Wolfgang Betz 9:3db68ab23070 447 init();
Wolfgang Betz 9:3db68ab23070 448 }
Wolfgang Betz 0:4fb29d9ee571 449 };