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@28:6a71e15d5272, 2016-11-17 (annotated)

Committer:
Wolfgang Betz
Date:
Thu Nov 17 08:24:29 2016 +0100
Revision:
28:6a71e15d5272
Parent:
25:2ec45788f28c
Child:
30:9c6dcfc47619
Backup commit

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