Blame view

RIOT/drivers/include/sx127x.h 22 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
  /*
   * Copyright (C) 2016 Unwired Devices <info@unwds.com>
   *               2017 Inria
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @defgroup    drivers_sx127x Semtech SX1272 and SX1276 radios driver
   * @ingroup     drivers_netdev
   * @brief       Driver for Semtech SX1272 and SX1276 radios.
   *
   * This module contains the driver for radio devices of the Semtech SX127x
   * series (SX1272 and SX1276).
   * Only LoRa long range modem is supported at the moment.
   *
   * SX127x modules are designed to be used in the ISM radio frequency (RF) band.
   * This RF band depends on different regional regulations worldwide.
   * Be careful to configure the device to use a RF frequency allowed in your
   * region.
   * Here is the list of allowed frequencies for your region (see
   * [LoRaWAN regional parameters document available online]
   * (https://www.lora-alliance.org/for-developers)):
   * - Europe has 2 allowed bands (ETSI):
   *   - EU863-870
   *   - EU433 (from 433.175MHZ to 434.665MHZ exactly)
   * - US is US902-928
   * - China has 2 allowed bands:
   *   - CN779-787 (from 779.5MHz to 786.5MHz exactly)
   *   - CN470-510 (from 470.3MHz to 509.7MHz exactly)
   * - Australia is AU915-928
   * - South asia, AS923:
   *   - Bruneï [923-925 MHz]
   *   - Cambodia [923-925 MHz]
   *   - Hong Kong [920-925 MHz]
   *   - Indonesia [923-925 MHz]
   *   - Japan [920-928 MHz]
   *   - Laos [923-925 MHz]
   *   - New Zealand [915-928 MHz]
   *   - Singapore [920-925 MHz]
   *   - Taiwan [922-928 MHz]
   *   - Thailand [920-925 MHz]
   *   - Vietnam [920-925 MHz]
   * - South Korea: KR920-923 (from 920.9MHz to 923.3MHz exactly)
   *
   * For more information on Semtech SX1272 and SX1276 modules see:
   * - [SX1272/73 datasheet](http://www.semtech.com/images/datasheet/sx1272.pdf)
   * - [SX1276/77/78/79 datasheet](http://www.semtech.com/images/datasheet/sx1276_77_78_79.pdf)
   *
   * @{
   *
   * @file
   * @brief       Public interface for SX127X driver
   * @author      Eugene P. <ep@unwds.com>
   * @author      Alexandre Abadie <alexandre.abadie@inria.fr>
   */
  
  #ifndef SX127X_H
  #define SX127X_H
  
  #include "xtimer.h"
  #include "net/netdev.h"
  #include "periph/gpio.h"
  #include "periph/spi.h"
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @name    SX127X device default configuration
   * @{
   */
  #define SX127X_MODEM_DEFAULT             (SX127X_MODEM_LORA)    /**< Use LoRa as default modem */
  #define SX127X_CHANNEL_DEFAULT           (868300000UL)          /**< Default channel frequency, 868.3MHz (Europe) */
  #define SX127X_HF_CHANNEL_DEFAULT        (868000000UL)          /**< Use to calibrate RX chain for LF and HF bands */
  #define SX127X_RF_MID_BAND_THRESH        (525000000UL)          /**< Mid-band threshold */
  #define SX127X_FREQUENCY_RESOLUTION      (61.03515625)          /**< Frequency resolution in Hz */
  #define SX127X_XTAL_FREQ                 (32000000UL)           /**< Internal oscillator frequency, 32MHz */
  #define SX127X_RADIO_WAKEUP_TIME         (1000U)                /**< In microseconds [us] */
  
  #define SX127X_PREAMBLE_LENGTH           (8U)                   /**< Preamble length, same for Tx and Rx */
  #define SX127X_SYMBOL_TIMEOUT            (10U)                  /**< Symbols timeout (s) */
  
  #define SX127X_BW_DEFAULT                (SX127X_BW_125_KHZ)    /**< Set default bandwidth to 125kHz */
  #define SX127X_SF_DEFAULT                (SX127X_SF12)          /**< Set default spreading factor to 12 */
  #define SX127X_CR_DEFAULT                (SX127X_CR_4_8)        /**< Set default coding rate to 8 */
  #define SX127X_FIX_LENGTH_PAYLOAD_ON     (false)                /**< Set fixed payload length on */
  #define SX127X_IQ_INVERSION              (false)                /**< Set inverted IQ on */
  #define SX127X_FREQUENCY_HOPPING         (false)                /**< Frequency hopping on */
  #define SX127X_FREQUENCY_HOPPING_PERIOD  (0U)                   /**< Frequency hopping period */
  #define SX127X_FIXED_HEADER_LEN_MODE     (false)                /**< Set fixed header length mode (implicit header) */
  #define SX127X_PAYLOAD_CRC_ON            (true)                 /**< Enable payload CRC, optional */
  #define SX127X_PAYLOAD_LENGTH            (0U)                   /**< Set payload length, unused with implicit header */
  
  #define SX127X_TX_TIMEOUT_DEFAULT        (1000U * 1000U * 30UL) /**< TX timeout, 30s */
  #define SX127X_RX_SINGLE                 (false)                /**< Single byte receive mode => continuous by default */
  #define SX127X_RX_BUFFER_SIZE            (256)                  /**< RX buffer size */
  
  #define SX127X_RADIO_TX_POWER            (14U)                  /**< Radio power in dBm */
  
  #ifndef SX1272_DEFAULT_PASELECT
  /** @brief   Default PA selection config (1: RFO, 0: PABOOST)
   *
   * This depends on the module configuration.
   */
  #define SX1272_DEFAULT_PASELECT          (1U)
  #endif
  
  #define SX127X_EVENT_HANDLER_STACK_SIZE  (2048U) /**< Stack size event handler */
  #define SX127X_IRQ_DIO0                  (1<<0)  /**< DIO0 IRQ */
  #define SX127X_IRQ_DIO1                  (1<<1)  /**< DIO1 IRQ */
  #define SX127X_IRQ_DIO2                  (1<<2)  /**< DIO2 IRQ */
  #define SX127X_IRQ_DIO3                  (1<<3)  /**< DIO3 IRQ */
  #define SX127X_IRQ_DIO4                  (1<<4)  /**< DIO4 IRQ */
  #define SX127X_IRQ_DIO5                  (1<<5)  /**< DIO5 IRQ */
  /** @} */
  
  /**
   * @brief   SX127X initialization result.
   */
  enum {
      SX127X_INIT_OK = 0,                /**< Initialization was successful */
      SX127X_ERR_SPI,                    /**< Failed to initialize SPI bus or CS line */
      SX127X_ERR_TEST_FAILED,            /**< SX127X testing failed during initialization (check chip) */
      SX127X_ERR_THREAD                  /**< Unable to create DIO handling thread (check amount of free memory) */
  };
  
  /**
   * @brief   Radio driver supported modems.
   */
  enum {
      SX127X_MODEM_FSK = 0,              /**< FSK modem driver */
      SX127X_MODEM_LORA,                 /**< LoRa modem driver */
  };
  
  /**
   * @brief   LoRa signal bandwidth.
   */
  enum {
      SX127X_BW_125_KHZ = 0,             /**< 125 kHz bandwidth */
      SX127X_BW_250_KHZ,                 /**< 250 kHz bandwidth */
      SX127X_BW_500_KHZ                  /**< 500 kHz bandwidth */
  };
  
  /**
   * @brief   LoRa spreading factor rate
   */
  enum {
      SX127X_SF6 = 6,                    /**< spreading factor 6 */
      SX127X_SF7,                        /**< spreading factor 7 */
      SX127X_SF8,                        /**< spreading factor 8 */
      SX127X_SF9,                        /**< spreading factor 9 */
      SX127X_SF10,                       /**< spreading factor 10 */
      SX127X_SF11,                       /**< spreading factor 11 */
      SX127X_SF12                        /**< spreading factor 12 */
  };
  
  /**
   * @brief   LoRa error coding rate.
   */
  enum {
      SX127X_CR_4_5 = 1,                 /**< coding rate 4/5 */
      SX127X_CR_4_6,                     /**< coding rate 4/6 */
      SX127X_CR_4_7,                     /**< coding rate 4/7 */
      SX127X_CR_4_8                      /**< coding rate 4/8 */
  };
  
  /**
   * @brief   Radio driver internal state machine states definition.
   */
  enum {
      SX127X_RF_IDLE = 0,                /**< Idle state */
      SX127X_RF_RX_RUNNING,              /**< Sending state */
      SX127X_RF_TX_RUNNING,              /**< Receiving state */
      SX127X_RF_CAD,                     /**< Channel activity detection state */
  };
  
  /**
   * @brief   Event types.
   */
  enum {
      SX127X_RX_DONE = 0,                /**< Receiving complete */
      SX127X_TX_DONE,                    /**< Sending complete*/
      SX127X_RX_TIMEOUT,                 /**< Receiving timeout */
      SX127X_TX_TIMEOUT,                 /**< Sending timeout */
      SX127X_RX_ERROR_CRC,               /**< Receiving CRC error */
      SX127X_FHSS_CHANGE_CHANNEL,        /**< Channel change */
      SX127X_CAD_DONE,                   /**< Channel activity detection complete */
  };
  
  /**
   * @name    SX127X device descriptor boolean flags
   * @{
   */
  #define SX127X_LOW_DATARATE_OPTIMIZE_FLAG       (1 << 0)
  #define SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG  (1 << 1)
  #define SX127X_ENABLE_CRC_FLAG                  (1 << 2)
  #define SX127X_CHANNEL_HOPPING_FLAG             (1 << 3)
  #define SX127X_IQ_INVERTED_FLAG                 (1 << 4)
  #define SX127X_RX_CONTINUOUS_FLAG               (1 << 5)
  /** @} */
  
  /**
   * @brief   LoRa configuration structure.
   */
  typedef struct {
      uint16_t preamble_len;             /**< Length of preamble header */
      uint8_t power;                     /**< Signal power */
      uint8_t bandwidth;                 /**< Signal bandwidth */
      uint8_t datarate;                  /**< Spreading factor rate, e.g datarate */
      uint8_t coderate;                  /**< Error coding rate */
      uint8_t freq_hop_period;           /**< Frequency hop period */
      uint8_t flags;                     /**< Boolean flags */
      uint32_t rx_timeout;               /**< RX timeout in symbols */
      uint32_t tx_timeout;               /**< TX timeout in symbols */
  } sx127x_lora_settings_t;
  
  /**
   * @brief   Radio settings.
   */
  typedef struct {
      uint32_t channel;                  /**< Radio channel */
      uint32_t window_timeout;           /**< Timeout window */
      uint8_t state;                     /**< Radio state */
      uint8_t modem;                     /**< Driver model (FSK or LoRa) */
      sx127x_lora_settings_t lora;       /**< LoRa settings */
  } sx127x_radio_settings_t;
  
  /**
   * @brief   SX127X internal data.
   */
  typedef struct {
      /* Data that will be passed to events handler in application */
      xtimer_t tx_timeout_timer;         /**< TX operation timeout timer */
      xtimer_t rx_timeout_timer;         /**< RX operation timeout timer */
      uint32_t last_channel;             /**< Last channel in frequency hopping sequence */
      bool is_last_cad_success;          /**< Sign of success of last CAD operation (activity detected) */
  } sx127x_internal_t;
  
  /**
   * @brief   SX127X hardware and global parameters.
   */
  typedef struct {
      spi_t spi;                         /**< SPI device */
      gpio_t nss_pin;                    /**< SPI NSS pin */
      gpio_t reset_pin;                  /**< Reset pin */
      gpio_t dio0_pin;                   /**< Interrupt line DIO0 (Tx done) */
      gpio_t dio1_pin;                   /**< Interrupt line DIO1 (Rx timeout) */
      gpio_t dio2_pin;                   /**< Interrupt line DIO2 (FHSS channel change) */
      gpio_t dio3_pin;                   /**< Interrupt line DIO3 (CAD done) */
      gpio_t dio4_pin;                   /**< Interrupt line DIO4 (not used) */
      gpio_t dio5_pin;                   /**< Interrupt line DIO5 (not used) */
  } sx127x_params_t;
  
  /**
   * @brief   SX127X IRQ flags.
   */
  typedef uint8_t sx127x_flags_t;
  
  /**
   * @brief   SX127X device descriptor.
   * @extends netdev_t
   */
  typedef struct {
      netdev_t netdev;                   /**< Netdev parent struct */
      sx127x_radio_settings_t settings;  /**< Radio settings */
      sx127x_params_t params;            /**< Device driver parameters */
      sx127x_internal_t _internal;       /**< Internal sx127x data used within the driver */
      sx127x_flags_t irq;                /**< Device IRQ flags */
  } sx127x_t;
  
  /**
   * @brief   Hardware IO IRQ callback function definition.
   */
  typedef void (sx127x_dio_irq_handler_t)(sx127x_t *dev);
  
  /**
   * @brief   Setup the SX127X
   *
   * @param[in] dev                      Device descriptor
   * @param[in] params                   Parameters for device initialization
   */
  void sx127x_setup(sx127x_t *dev, const sx127x_params_t *params);
  
  /**
   * @brief   Resets the SX127X
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_reset(const sx127x_t *dev);
  
  /**
   * @brief   Initializes the transceiver.
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return result of initialization
   */
  int sx127x_init(sx127x_t *dev);
  
  /**
   * @brief   Initialize radio settings with default values
   *
   * @param[in] dev                      The sx127x device pointer
   */
  void sx127x_init_radio_settings(sx127x_t *dev);
  
  /**
   * @brief   Generates 32 bits random value based on the RSSI readings
   *
   * @attention This function sets the radio in LoRa mode and disables all
   *            interrupts from it. After calling this function either
   *            sx127x_set_rx_config or sx127x_set_tx_config functions must
   *            be called.
   *
   * @param[in] dev                      The sx127x device structure pointer
   *
   * @return random 32 bits value
   */
  uint32_t sx127x_random(sx127x_t *dev);
  
  /**
   * @brief   Start a channel activity detection.
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_start_cad(sx127x_t *dev);
  
  /**
   * @brief   Gets current state of transceiver.
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return radio state [RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
   */
  uint8_t sx127x_get_state(const sx127x_t *dev);
  
  /**
   * @brief   Sets current state of transceiver.
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] state                    The new radio state
   *
   * @return radio state [RF_IDLE, RF_RX_RUNNING, RF_TX_RUNNING]
   */
  void sx127x_set_state(sx127x_t *dev, uint8_t state);
  
  /**
   * @brief   Configures the radio with the given modem.
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] modem                    Modem to be used [0: FSK, 1: LoRa]
   */
  void sx127x_set_modem(sx127x_t *dev, uint8_t modem);
  
  /**
   * @brief   Gets the synchronization word.
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return The synchronization word
   */
  uint8_t sx127x_get_syncword(const sx127x_t *dev);
  
  /**
   * @brief   Sets the synchronization word.
   *
   * @param[in] dev                     The sx127x device descriptor
   * @param[in] syncword                The synchronization word
   */
  void sx127x_set_syncword(sx127x_t *dev, uint8_t syncword);
  
  /**
   * @brief   Gets the channel RF frequency.
   *
   * @param[in]  dev                     The sx127x device descriptor
   *
   * @return The channel frequency
   */
  uint32_t sx127x_get_channel(const sx127x_t *dev);
  
  /**
   * @brief   Sets the channel RF frequency.
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] freq                     Channel RF frequency
   */
  void sx127x_set_channel(sx127x_t *dev, uint32_t freq);
  
  /**
   * @brief   Computes the packet time on air in milliseconds.
   *
   * @pre     Can only be called if sx127x_init_radio_settings has already
   *          been called.
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] pkt_len                  The received packet payload length
   *
   * @return computed air time (ms) for the given packet payload length
   */
  uint32_t sx127x_get_time_on_air(const sx127x_t *dev, uint8_t pkt_len);
  
  /**
   * @brief   Sets the radio in sleep mode
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_set_sleep(sx127x_t *dev);
  
  /**
   * @brief   Sets the radio in stand-by mode
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_set_standby(sx127x_t *dev);
  
  /**
   * @brief   Sets the radio in reception mode.
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_set_rx(sx127x_t *dev);
  
  /**
   * @brief   Sets the radio in transmission mode.
   *
   * @param[in] dev                      The sx127x device descriptor
   */
  void sx127x_set_tx(sx127x_t *dev);
  
  /**
   * @brief   Gets the maximum payload length.
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return The maximum payload length
   */
  uint8_t sx127x_get_max_payload_len(const sx127x_t *dev);
  
  /**
   * @brief   Sets the maximum payload length.
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] maxlen                   Maximum payload length in bytes
   */
  void sx127x_set_max_payload_len(const sx127x_t *dev, uint8_t maxlen);
  
  /**
   * @brief   Gets the SX127X operating mode
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return The actual operating mode
   */
  uint8_t sx127x_get_op_mode(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X operating mode
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] op_mode                  The new operating mode
   */
  void sx127x_set_op_mode(const sx127x_t *dev, uint8_t op_mode);
  
  /**
   * @brief   Gets the SX127X bandwidth
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the bandwidth
   */
  uint8_t sx127x_get_bandwidth(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X bandwidth
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] bandwidth                The new bandwidth
   */
  void sx127x_set_bandwidth(sx127x_t *dev, uint8_t bandwidth);
  
  /**
   * @brief   Gets the SX127X LoRa spreading factor
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the spreading factor
   */
  uint8_t sx127x_get_spreading_factor(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X LoRa spreading factor
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] sf                       The spreading factor
   */
  void sx127x_set_spreading_factor(sx127x_t *dev, uint8_t sf);
  
  /**
   * @brief   Gets the SX127X LoRa coding rate
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the current LoRa coding rate
   */
  uint8_t sx127x_get_coding_rate(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X LoRa coding rate
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] coderate                 The LoRa coding rate
   */
  void sx127x_set_coding_rate(sx127x_t *dev, uint8_t coderate);
  
  /**
   * @brief   Checks if the SX127X LoRa RX single mode is enabled/disabled
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the LoRa single mode
   */
  bool sx127x_get_rx_single(const sx127x_t *dev);
  
  /**
   * @brief   Enable/disable the SX127X LoRa RX single mode
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] single                   The LoRa RX single mode
   */
  void sx127x_set_rx_single(sx127x_t *dev, bool single);
  
  /**
   * @brief   Checks if the SX127X CRC verification mode is enabled
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the LoRa single mode
   */
  bool sx127x_get_crc(const sx127x_t *dev);
  
  /**
   * @brief   Enable/Disable the SX127X CRC verification mode
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] crc                      The CRC check mode
   */
  void sx127x_set_crc(sx127x_t *dev, bool crc);
  
  /**
   * @brief   Gets the SX127X frequency hopping period
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the frequency hopping period
   */
  uint8_t sx127x_get_hop_period(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X frequency hopping period
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] hop_period               The frequency hopping period
   */
  void sx127x_set_hop_period(sx127x_t *dev, uint8_t hop_period);
  
  /**
   * @brief   Gets the SX127X LoRa fixed header length mode
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the LoRa implicit mode
   */
  bool sx127x_get_fixed_header_len_mode(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X to fixed header length mode (explicit mode)
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] mode                     The header mode
   */
  void sx127x_set_fixed_header_len_mode(sx127x_t *dev, bool mode);
  
  /**
   * @brief   Gets the SX127X payload length
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the payload length
   */
  uint8_t sx127x_get_payload_length(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X payload length
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] len                      The payload len
   */
  void sx127x_set_payload_length(sx127x_t *dev, uint8_t len);
  
  /**
   * @brief   Gets the SX127X TX radio power
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the radio power
   */
  uint8_t sx127x_get_tx_power(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X transmission power
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] power                    The TX power
   */
  void sx127x_set_tx_power(sx127x_t *dev, uint8_t power);
  
  /**
   * @brief   Gets the SX127X preamble length
   *
   * @param[in] dev                      The sx127x device descriptor
   *
   * @return the preamble length
   */
  uint16_t sx127x_get_preamble_length(const sx127x_t *dev);
  
  /**
   * @brief   Sets the SX127X LoRa preamble length
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] preamble                 The LoRa preamble length
   */
  void sx127x_set_preamble_length(sx127x_t *dev, uint16_t preamble);
  
  /**
   * @brief   Sets the SX127X LoRa symbol timeout
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] timeout                  The LoRa symbol timeout
   */
  void sx127x_set_symbol_timeout(sx127x_t *dev, uint16_t timeout);
  
  /**
   * @brief   Sets the SX127X RX timeout
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] timeout                  The RX timeout
   */
  void sx127x_set_rx_timeout(sx127x_t *dev, uint32_t timeout);
  
  /**
   * @brief   Sets the SX127X TX timeout
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] timeout                  The TX timeout
   */
  void sx127x_set_tx_timeout(sx127x_t *dev, uint32_t timeout);
  
  /**
   * @brief   Sets the SX127X LoRa IQ inverted mode
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] iq_invert                The LoRa IQ inverted mode
   */
  void sx127x_set_iq_invert(sx127x_t *dev, bool iq_invert);
  
  /**
   * @brief   Sets the SX127X LoRa frequency hopping mode
   *
   * @param[in] dev                      The sx127x device descriptor
   * @param[in] freq_hop_on              The LoRa frequency hopping mode
   */
  void sx127x_set_freq_hop(sx127x_t *dev, bool freq_hop_on);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* SX127X_H */
  /** @} */