sx1276-LoRa.h 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. /*
  2. * THE FOLLOWING FIRMWARE IS PROVIDED: (1) "AS IS" WITH NO WARRANTY; AND
  3. * (2)TO ENABLE ACCESS TO CODING INFORMATION TO GUIDE AND FACILITATE CUSTOMER.
  4. * CONSEQUENTLY, SEMTECH SHALL NOT BE HELD LIABLE FOR ANY DIRECT, INDIRECT OR
  5. * CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE CONTENT
  6. * OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING INFORMATION
  7. * CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
  8. *
  9. * Copyright (C) SEMTECH S.A.
  10. */
  11. /*!
  12. * \file sx1276-LoRa.h
  13. * \brief SX1276 RF chip driver mode LoRa
  14. *
  15. * \version 2.0.B2
  16. * \date May 6 2013
  17. * \author Gregory Cristian
  18. *
  19. * Last modified by Miguel Luis on Jun 19 2013
  20. */
  21. #ifndef __SX1276_LORA_H__
  22. #define __SX1276_LORA_H__
  23. /*!
  24. * SX1276 LoRa General parameters definition
  25. */
  26. typedef struct sLoRaSettings
  27. {
  28. uint32_t RFFrequency;
  29. int8_t Power;
  30. uint8_t SignalBw; // LORA [0: 7.8 kHz, 1: 10.4 kHz, 2: 15.6 kHz, 3: 20.8 kHz, 4: 31.2 kHz,
  31. // 5: 41.6 kHz, 6: 62.5 kHz, 7: 125 kHz, 8: 250 kHz, 9: 500 kHz, other: Reserved]
  32. uint8_t SpreadingFactor; // LORA [6: 64, 7: 128, 8: 256, 9: 512, 10: 1024, 11: 2048, 12: 4096 chips]
  33. uint8_t ErrorCoding; // LORA [1: 4/5, 2: 4/6, 3: 4/7, 4: 4/8]
  34. bool CrcOn; // [0: OFF, 1: ON]
  35. bool ImplicitHeaderOn; // [0: OFF, 1: ON]
  36. bool RxSingleOn; // [0: Continuous, 1 Single]
  37. bool FreqHopOn; // [0: OFF, 1: ON]
  38. uint8_t HopPeriod; // Hops every frequency hopping period symbols
  39. uint32_t TxPacketTimeout;
  40. uint32_t RxPacketTimeout;
  41. uint8_t PayloadLength;
  42. }tLoRaSettings;
  43. /*!
  44. * RF packet definition
  45. */
  46. #define RF_BUFFER_SIZE_MAX 256
  47. #define RF_BUFFER_SIZE 256
  48. /*!
  49. * RF state machine
  50. */
  51. //LoRa
  52. typedef enum
  53. {
  54. RFLR_STATE_IDLE,
  55. RFLR_STATE_RX_INIT,
  56. RFLR_STATE_RX_RUNNING,
  57. RFLR_STATE_RX_DONE,
  58. RFLR_STATE_RX_TIMEOUT,
  59. RFLR_STATE_TX_INIT,
  60. RFLR_STATE_TX_RUNNING,
  61. RFLR_STATE_TX_DONE,
  62. RFLR_STATE_TX_TIMEOUT,
  63. RFLR_STATE_CAD_INIT,
  64. RFLR_STATE_CAD_RUNNING
  65. }tRFLRStates;
  66. /*!
  67. * SX1276 definitions
  68. */
  69. #define XTAL_FREQ 32000000
  70. #define FREQ_STEP 61.03515625
  71. /*!
  72. * SX1276 Internal registers Address
  73. */
  74. #define REG_LR_FIFO 0x00
  75. // Common settings
  76. #define REG_LR_OPMODE 0x01
  77. #define REG_LR_BANDSETTING 0x04
  78. #define REG_LR_FRFMSB 0x06
  79. #define REG_LR_FRFMID 0x07
  80. #define REG_LR_FRFLSB 0x08
  81. // Tx settings
  82. #define REG_LR_PACONFIG 0x09
  83. #define REG_LR_PARAMP 0x0A
  84. #define REG_LR_OCP 0x0B
  85. // Rx settings
  86. #define REG_LR_LNA 0x0C
  87. // LoRa registers
  88. #define REG_LR_FIFOADDRPTR 0x0D
  89. #define REG_LR_FIFOTXBASEADDR 0x0E
  90. #define REG_LR_FIFORXBASEADDR 0x0F
  91. #define REG_LR_FIFORXCURRENTADDR 0x10
  92. #define REG_LR_IRQFLAGSMASK 0x11
  93. #define REG_LR_IRQFLAGS 0x12
  94. #define REG_LR_NBRXBYTES 0x13
  95. #define REG_LR_RXHEADERCNTVALUEMSB 0x14
  96. #define REG_LR_RXHEADERCNTVALUELSB 0x15
  97. #define REG_LR_RXPACKETCNTVALUEMSB 0x16
  98. #define REG_LR_RXPACKETCNTVALUELSB 0x17
  99. #define REG_LR_MODEMSTAT 0x18
  100. #define REG_LR_PKTSNRVALUE 0x19
  101. #define REG_LR_PKTRSSIVALUE 0x1A
  102. #define REG_LR_RSSIVALUE 0x1B
  103. #define REG_LR_HOPCHANNEL 0x1C
  104. #define REG_LR_MODEMCONFIG1 0x1D
  105. #define REG_LR_MODEMCONFIG2 0x1E
  106. #define REG_LR_SYMBTIMEOUTLSB 0x1F
  107. #define REG_LR_PREAMBLEMSB 0x20
  108. #define REG_LR_PREAMBLELSB 0x21
  109. #define REG_LR_PAYLOADLENGTH 0x22
  110. #define REG_LR_PAYLOADMAXLENGTH 0x23
  111. #define REG_LR_HOPPERIOD 0x24
  112. #define REG_LR_FIFORXBYTEADDR 0x25
  113. #define REG_LR_MODEMCONFIG3 0x26
  114. // end of documented register in datasheet
  115. // I/O settings
  116. #define REG_LR_DIOMAPPING1 0x40
  117. #define REG_LR_DIOMAPPING2 0x41
  118. // Version
  119. #define REG_LR_VERSION 0x42
  120. // Additional settings
  121. #define REG_LR_PLLHOP 0x44
  122. #define REG_LR_TCXO 0x4B
  123. #define REG_LR_PADAC 0x4D
  124. #define REG_LR_FORMERTEMP 0x5B
  125. #define REG_LR_BITRATEFRAC 0x5D
  126. #define REG_LR_AGCREF 0x61
  127. #define REG_LR_AGCTHRESH1 0x62
  128. #define REG_LR_AGCTHRESH2 0x63
  129. #define REG_LR_AGCTHRESH3 0x64
  130. /*!
  131. * SX1276 LoRa bit control definition
  132. */
  133. /*!
  134. * RegFifo
  135. */
  136. /*!
  137. * RegOpMode
  138. */
  139. #define RFLR_OPMODE_LONGRANGEMODE_MASK 0x7F
  140. #define RFLR_OPMODE_LONGRANGEMODE_OFF 0x00 // Default
  141. #define RFLR_OPMODE_LONGRANGEMODE_ON 0x80
  142. #define RFLR_OPMODE_ACCESSSHAREDREG_MASK 0xBF
  143. #define RFLR_OPMODE_ACCESSSHAREDREG_ENABLE 0x40
  144. #define RFLR_OPMODE_ACCESSSHAREDREG_DISABLE 0x00 // Default
  145. #define RFLR_OPMODE_FREQMODE_ACCESS_MASK 0xF7
  146. #define RFLR_OPMODE_FREQMODE_ACCESS_LF 0x08 // Default
  147. #define RFLR_OPMODE_FREQMODE_ACCESS_HF 0x00
  148. #define RFLR_OPMODE_MASK 0xF8
  149. #define RFLR_OPMODE_SLEEP 0x00
  150. #define RFLR_OPMODE_STANDBY 0x01 // Default
  151. #define RFLR_OPMODE_SYNTHESIZER_TX 0x02
  152. #define RFLR_OPMODE_TRANSMITTER 0x03
  153. #define RFLR_OPMODE_SYNTHESIZER_RX 0x04
  154. #define RFLR_OPMODE_RECEIVER 0x05
  155. // LoRa specific modes
  156. #define RFLR_OPMODE_RECEIVER_SINGLE 0x06
  157. #define RFLR_OPMODE_CAD 0x07
  158. /*!
  159. * RegBandSetting
  160. */
  161. #define RFLR_BANDSETTING_MASK 0x3F
  162. #define RFLR_BANDSETTING_AUTO 0x00 // Default
  163. #define RFLR_BANDSETTING_DIV_BY_1 0x40
  164. #define RFLR_BANDSETTING_DIV_BY_2 0x80
  165. #define RFLR_BANDSETTING_DIV_BY_6 0xC0
  166. /*!
  167. * RegFrf (MHz)
  168. */
  169. #define RFLR_FRFMSB_434_MHZ 0x6C // Default
  170. #define RFLR_FRFMID_434_MHZ 0x80 // Default
  171. #define RFLR_FRFLSB_434_MHZ 0x00 // Default
  172. #define RFLR_FRFMSB_863_MHZ 0xD7
  173. #define RFLR_FRFMID_863_MHZ 0xC0
  174. #define RFLR_FRFLSB_863_MHZ 0x00
  175. #define RFLR_FRFMSB_864_MHZ 0xD8
  176. #define RFLR_FRFMID_864_MHZ 0x00
  177. #define RFLR_FRFLSB_864_MHZ 0x00
  178. #define RFLR_FRFMSB_865_MHZ 0xD8
  179. #define RFLR_FRFMID_865_MHZ 0x40
  180. #define RFLR_FRFLSB_865_MHZ 0x00
  181. #define RFLR_FRFMSB_866_MHZ 0xD8
  182. #define RFLR_FRFMID_866_MHZ 0x80
  183. #define RFLR_FRFLSB_866_MHZ 0x00
  184. #define RFLR_FRFMSB_867_MHZ 0xD8
  185. #define RFLR_FRFMID_867_MHZ 0xC0
  186. #define RFLR_FRFLSB_867_MHZ 0x00
  187. #define RFLR_FRFMSB_868_MHZ 0xD9
  188. #define RFLR_FRFMID_868_MHZ 0x00
  189. #define RFLR_FRFLSB_868_MHZ 0x00
  190. #define RFLR_FRFMSB_869_MHZ 0xD9
  191. #define RFLR_FRFMID_869_MHZ 0x40
  192. #define RFLR_FRFLSB_869_MHZ 0x00
  193. #define RFLR_FRFMSB_870_MHZ 0xD9
  194. #define RFLR_FRFMID_870_MHZ 0x80
  195. #define RFLR_FRFLSB_870_MHZ 0x00
  196. #define RFLR_FRFMSB_902_MHZ 0xE1
  197. #define RFLR_FRFMID_902_MHZ 0x80
  198. #define RFLR_FRFLSB_902_MHZ 0x00
  199. #define RFLR_FRFMSB_903_MHZ 0xE1
  200. #define RFLR_FRFMID_903_MHZ 0xC0
  201. #define RFLR_FRFLSB_903_MHZ 0x00
  202. #define RFLR_FRFMSB_904_MHZ 0xE2
  203. #define RFLR_FRFMID_904_MHZ 0x00
  204. #define RFLR_FRFLSB_904_MHZ 0x00
  205. #define RFLR_FRFMSB_905_MHZ 0xE2
  206. #define RFLR_FRFMID_905_MHZ 0x40
  207. #define RFLR_FRFLSB_905_MHZ 0x00
  208. #define RFLR_FRFMSB_906_MHZ 0xE2
  209. #define RFLR_FRFMID_906_MHZ 0x80
  210. #define RFLR_FRFLSB_906_MHZ 0x00
  211. #define RFLR_FRFMSB_907_MHZ 0xE2
  212. #define RFLR_FRFMID_907_MHZ 0xC0
  213. #define RFLR_FRFLSB_907_MHZ 0x00
  214. #define RFLR_FRFMSB_908_MHZ 0xE3
  215. #define RFLR_FRFMID_908_MHZ 0x00
  216. #define RFLR_FRFLSB_908_MHZ 0x00
  217. #define RFLR_FRFMSB_909_MHZ 0xE3
  218. #define RFLR_FRFMID_909_MHZ 0x40
  219. #define RFLR_FRFLSB_909_MHZ 0x00
  220. #define RFLR_FRFMSB_910_MHZ 0xE3
  221. #define RFLR_FRFMID_910_MHZ 0x80
  222. #define RFLR_FRFLSB_910_MHZ 0x00
  223. #define RFLR_FRFMSB_911_MHZ 0xE3
  224. #define RFLR_FRFMID_911_MHZ 0xC0
  225. #define RFLR_FRFLSB_911_MHZ 0x00
  226. #define RFLR_FRFMSB_912_MHZ 0xE4
  227. #define RFLR_FRFMID_912_MHZ 0x00
  228. #define RFLR_FRFLSB_912_MHZ 0x00
  229. #define RFLR_FRFMSB_913_MHZ 0xE4
  230. #define RFLR_FRFMID_913_MHZ 0x40
  231. #define RFLR_FRFLSB_913_MHZ 0x00
  232. #define RFLR_FRFMSB_914_MHZ 0xE4
  233. #define RFLR_FRFMID_914_MHZ 0x80
  234. #define RFLR_FRFLSB_914_MHZ 0x00
  235. #define RFLR_FRFMSB_915_MHZ 0xE4 // Default
  236. #define RFLR_FRFMID_915_MHZ 0xC0 // Default
  237. #define RFLR_FRFLSB_915_MHZ 0x00 // Default
  238. #define RFLR_FRFMSB_916_MHZ 0xE5
  239. #define RFLR_FRFMID_916_MHZ 0x00
  240. #define RFLR_FRFLSB_916_MHZ 0x00
  241. #define RFLR_FRFMSB_917_MHZ 0xE5
  242. #define RFLR_FRFMID_917_MHZ 0x40
  243. #define RFLR_FRFLSB_917_MHZ 0x00
  244. #define RFLR_FRFMSB_918_MHZ 0xE5
  245. #define RFLR_FRFMID_918_MHZ 0x80
  246. #define RFLR_FRFLSB_918_MHZ 0x00
  247. #define RFLR_FRFMSB_919_MHZ 0xE5
  248. #define RFLR_FRFMID_919_MHZ 0xC0
  249. #define RFLR_FRFLSB_919_MHZ 0x00
  250. #define RFLR_FRFMSB_920_MHZ 0xE6
  251. #define RFLR_FRFMID_920_MHZ 0x00
  252. #define RFLR_FRFLSB_920_MHZ 0x00
  253. #define RFLR_FRFMSB_921_MHZ 0xE6
  254. #define RFLR_FRFMID_921_MHZ 0x40
  255. #define RFLR_FRFLSB_921_MHZ 0x00
  256. #define RFLR_FRFMSB_922_MHZ 0xE6
  257. #define RFLR_FRFMID_922_MHZ 0x80
  258. #define RFLR_FRFLSB_922_MHZ 0x00
  259. #define RFLR_FRFMSB_923_MHZ 0xE6
  260. #define RFLR_FRFMID_923_MHZ 0xC0
  261. #define RFLR_FRFLSB_923_MHZ 0x00
  262. #define RFLR_FRFMSB_924_MHZ 0xE7
  263. #define RFLR_FRFMID_924_MHZ 0x00
  264. #define RFLR_FRFLSB_924_MHZ 0x00
  265. #define RFLR_FRFMSB_925_MHZ 0xE7
  266. #define RFLR_FRFMID_925_MHZ 0x40
  267. #define RFLR_FRFLSB_925_MHZ 0x00
  268. #define RFLR_FRFMSB_926_MHZ 0xE7
  269. #define RFLR_FRFMID_926_MHZ 0x80
  270. #define RFLR_FRFLSB_926_MHZ 0x00
  271. #define RFLR_FRFMSB_927_MHZ 0xE7
  272. #define RFLR_FRFMID_927_MHZ 0xC0
  273. #define RFLR_FRFLSB_927_MHZ 0x00
  274. #define RFLR_FRFMSB_928_MHZ 0xE8
  275. #define RFLR_FRFMID_928_MHZ 0x00
  276. #define RFLR_FRFLSB_928_MHZ 0x00
  277. /*!
  278. * RegPaConfig
  279. */
  280. #define RFLR_PACONFIG_PASELECT_MASK 0x7F
  281. #define RFLR_PACONFIG_PASELECT_PABOOST 0x80
  282. #define RFLR_PACONFIG_PASELECT_RFO 0x00 // Default
  283. #define RFLR_PACONFIG_MAX_POWER_MASK 0x8F
  284. #define RFLR_PACONFIG_OUTPUTPOWER_MASK 0xF0
  285. /*!
  286. * RegPaRamp
  287. */
  288. #define RFLR_PARAMP_TXBANDFORCE_MASK 0xEF
  289. #define RFLR_PARAMP_TXBANDFORCE_BAND_SEL 0x10
  290. #define RFLR_PARAMP_TXBANDFORCE_AUTO 0x00 // Default
  291. #define RFLR_PARAMP_MASK 0xF0
  292. #define RFLR_PARAMP_3400_US 0x00
  293. #define RFLR_PARAMP_2000_US 0x01
  294. #define RFLR_PARAMP_1000_US 0x02
  295. #define RFLR_PARAMP_0500_US 0x03
  296. #define RFLR_PARAMP_0250_US 0x04
  297. #define RFLR_PARAMP_0125_US 0x05
  298. #define RFLR_PARAMP_0100_US 0x06
  299. #define RFLR_PARAMP_0062_US 0x07
  300. #define RFLR_PARAMP_0050_US 0x08
  301. #define RFLR_PARAMP_0040_US 0x09 // Default
  302. #define RFLR_PARAMP_0031_US 0x0A
  303. #define RFLR_PARAMP_0025_US 0x0B
  304. #define RFLR_PARAMP_0020_US 0x0C
  305. #define RFLR_PARAMP_0015_US 0x0D
  306. #define RFLR_PARAMP_0012_US 0x0E
  307. #define RFLR_PARAMP_0010_US 0x0F
  308. /*!
  309. * RegOcp
  310. */
  311. #define RFLR_OCP_MASK 0xDF
  312. #define RFLR_OCP_ON 0x20 // Default
  313. #define RFLR_OCP_OFF 0x00
  314. #define RFLR_OCP_TRIM_MASK 0xE0
  315. #define RFLR_OCP_TRIM_045_MA 0x00
  316. #define RFLR_OCP_TRIM_050_MA 0x01
  317. #define RFLR_OCP_TRIM_055_MA 0x02
  318. #define RFLR_OCP_TRIM_060_MA 0x03
  319. #define RFLR_OCP_TRIM_065_MA 0x04
  320. #define RFLR_OCP_TRIM_070_MA 0x05
  321. #define RFLR_OCP_TRIM_075_MA 0x06
  322. #define RFLR_OCP_TRIM_080_MA 0x07
  323. #define RFLR_OCP_TRIM_085_MA 0x08
  324. #define RFLR_OCP_TRIM_090_MA 0x09
  325. #define RFLR_OCP_TRIM_095_MA 0x0A
  326. #define RFLR_OCP_TRIM_100_MA 0x0B // Default
  327. #define RFLR_OCP_TRIM_105_MA 0x0C
  328. #define RFLR_OCP_TRIM_110_MA 0x0D
  329. #define RFLR_OCP_TRIM_115_MA 0x0E
  330. #define RFLR_OCP_TRIM_120_MA 0x0F
  331. #define RFLR_OCP_TRIM_130_MA 0x10
  332. #define RFLR_OCP_TRIM_140_MA 0x11
  333. #define RFLR_OCP_TRIM_150_MA 0x12
  334. #define RFLR_OCP_TRIM_160_MA 0x13
  335. #define RFLR_OCP_TRIM_170_MA 0x14
  336. #define RFLR_OCP_TRIM_180_MA 0x15
  337. #define RFLR_OCP_TRIM_190_MA 0x16
  338. #define RFLR_OCP_TRIM_200_MA 0x17
  339. #define RFLR_OCP_TRIM_210_MA 0x18
  340. #define RFLR_OCP_TRIM_220_MA 0x19
  341. #define RFLR_OCP_TRIM_230_MA 0x1A
  342. #define RFLR_OCP_TRIM_240_MA 0x1B
  343. /*!
  344. * RegLna
  345. */
  346. #define RFLR_LNA_GAIN_MASK 0x1F
  347. #define RFLR_LNA_GAIN_G1 0x20 // Default
  348. #define RFLR_LNA_GAIN_G2 0x40
  349. #define RFLR_LNA_GAIN_G3 0x60
  350. #define RFLR_LNA_GAIN_G4 0x80
  351. #define RFLR_LNA_GAIN_G5 0xA0
  352. #define RFLR_LNA_GAIN_G6 0xC0
  353. #define RFLR_LNA_BOOST_LF_MASK 0xE7
  354. #define RFLR_LNA_BOOST_LF_DEFAULT 0x00 // Default
  355. #define RFLR_LNA_BOOST_LF_GAIN 0x08
  356. #define RFLR_LNA_BOOST_LF_IP3 0x10
  357. #define RFLR_LNA_BOOST_LF_BOOST 0x18
  358. #define RFLR_LNA_RXBANDFORCE_MASK 0xFB
  359. #define RFLR_LNA_RXBANDFORCE_BAND_SEL 0x04
  360. #define RFLR_LNA_RXBANDFORCE_AUTO 0x00 // Default
  361. #define RFLR_LNA_BOOST_HF_MASK 0xFC
  362. #define RFLR_LNA_BOOST_HF_OFF 0x00 // Default
  363. #define RFLR_LNA_BOOST_HF_ON 0x03
  364. /*!
  365. * RegFifoAddrPtr
  366. */
  367. #define RFLR_FIFOADDRPTR 0x00 // Default
  368. /*!
  369. * RegFifoTxBaseAddr
  370. */
  371. #define RFLR_FIFOTXBASEADDR 0x80 // Default
  372. /*!
  373. * RegFifoTxBaseAddr
  374. */
  375. #define RFLR_FIFORXBASEADDR 0x00 // Default
  376. /*!
  377. * RegFifoRxCurrentAddr (Read Only)
  378. */
  379. /*!
  380. * RegIrqFlagsMask
  381. */
  382. #define RFLR_IRQFLAGS_RXTIMEOUT_MASK 0x80
  383. #define RFLR_IRQFLAGS_RXDONE_MASK 0x40
  384. #define RFLR_IRQFLAGS_PAYLOADCRCERROR_MASK 0x20
  385. #define RFLR_IRQFLAGS_VALIDHEADER_MASK 0x10
  386. #define RFLR_IRQFLAGS_TXDONE_MASK 0x08
  387. #define RFLR_IRQFLAGS_CADDONE_MASK 0x04
  388. #define RFLR_IRQFLAGS_FHSSCHANGEDCHANNEL_MASK 0x02
  389. #define RFLR_IRQFLAGS_CADDETECTED_MASK 0x01
  390. /*!
  391. * RegIrqFlags
  392. */
  393. #define RFLR_IRQFLAGS_RXTIMEOUT 0x80
  394. #define RFLR_IRQFLAGS_RXDONE 0x40
  395. #define RFLR_IRQFLAGS_PAYLOADCRCERROR 0x20
  396. #define RFLR_IRQFLAGS_VALIDHEADER 0x10
  397. #define RFLR_IRQFLAGS_TXDONE 0x08
  398. #define RFLR_IRQFLAGS_CADDONE 0x04
  399. #define RFLR_IRQFLAGS_FHSSCHANGEDCHANNEL 0x02
  400. #define RFLR_IRQFLAGS_CADDETECTED 0x01
  401. /*!
  402. * RegFifoRxNbBytes (Read Only) //
  403. */
  404. /*!
  405. * RegRxHeaderCntValueMsb (Read Only) //
  406. */
  407. /*!
  408. * RegRxHeaderCntValueLsb (Read Only) //
  409. */
  410. /*!
  411. * RegRxPacketCntValueMsb (Read Only) //
  412. */
  413. /*!
  414. * RegRxPacketCntValueLsb (Read Only) //
  415. */
  416. /*!
  417. * RegModemStat (Read Only) //
  418. */
  419. #define RFLR_MODEMSTAT_RX_CR_MASK 0x1F
  420. #define RFLR_MODEMSTAT_MODEM_STATUS_MASK 0xE0
  421. /*!
  422. * RegPktSnrValue (Read Only) //
  423. */
  424. /*!
  425. * RegPktRssiValue (Read Only) //
  426. */
  427. /*!
  428. * RegRssiValue (Read Only) //
  429. */
  430. /*!
  431. * RegModemConfig1
  432. */
  433. #define RFLR_MODEMCONFIG1_BW_MASK 0x0F
  434. #define RFLR_MODEMCONFIG1_BW_7_81_KHZ 0x00
  435. #define RFLR_MODEMCONFIG1_BW_10_41_KHZ 0x10
  436. #define RFLR_MODEMCONFIG1_BW_15_62_KHZ 0x20
  437. #define RFLR_MODEMCONFIG1_BW_20_83_KHZ 0x30
  438. #define RFLR_MODEMCONFIG1_BW_31_25_KHZ 0x40
  439. #define RFLR_MODEMCONFIG1_BW_41_66_KHZ 0x50
  440. #define RFLR_MODEMCONFIG1_BW_62_50_KHZ 0x60
  441. #define RFLR_MODEMCONFIG1_BW_125_KHZ 0x70 // Default
  442. #define RFLR_MODEMCONFIG1_BW_250_KHZ 0x80
  443. #define RFLR_MODEMCONFIG1_BW_500_KHZ 0x90
  444. #define RFLR_MODEMCONFIG1_CODINGRATE_MASK 0xF1
  445. #define RFLR_MODEMCONFIG1_CODINGRATE_4_5 0x02
  446. #define RFLR_MODEMCONFIG1_CODINGRATE_4_6 0x04 // Default
  447. #define RFLR_MODEMCONFIG1_CODINGRATE_4_7 0x06
  448. #define RFLR_MODEMCONFIG1_CODINGRATE_4_8 0x08
  449. #define RFLR_MODEMCONFIG1_IMPLICITHEADER_MASK 0xFE
  450. #define RFLR_MODEMCONFIG1_IMPLICITHEADER_ON 0x01
  451. #define RFLR_MODEMCONFIG1_IMPLICITHEADER_OFF 0x00 // Default
  452. /*!
  453. * RegModemConfig2
  454. */
  455. #define RFLR_MODEMCONFIG2_SF_MASK 0x0F
  456. #define RFLR_MODEMCONFIG2_SF_6 0x60
  457. #define RFLR_MODEMCONFIG2_SF_7 0x70 // Default
  458. #define RFLR_MODEMCONFIG2_SF_8 0x80
  459. #define RFLR_MODEMCONFIG2_SF_9 0x90
  460. #define RFLR_MODEMCONFIG2_SF_10 0xA0
  461. #define RFLR_MODEMCONFIG2_SF_11 0xB0
  462. #define RFLR_MODEMCONFIG2_SF_12 0xC0
  463. #define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_MASK 0xF7
  464. #define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_ON 0x08
  465. #define RFLR_MODEMCONFIG2_TXCONTINUOUSMODE_OFF 0x00
  466. #define RFLR_MODEMCONFIG2_RXPAYLOADCRC_MASK 0xFB
  467. #define RFLR_MODEMCONFIG2_RXPAYLOADCRC_ON 0x04
  468. #define RFLR_MODEMCONFIG2_RXPAYLOADCRC_OFF 0x00 // Default
  469. #define RFLR_MODEMCONFIG2_SYMBTIMEOUTMSB_MASK 0xFC
  470. #define RFLR_MODEMCONFIG2_SYMBTIMEOUTMSB 0x00 // Default
  471. /*!
  472. * RegHopChannel (Read Only)
  473. */
  474. #define RFLR_HOPCHANNEL_PLL_LOCK_TIMEOUT_MASK 0x7F
  475. #define RFLR_HOPCHANNEL_PLL_LOCK_FAIL 0x80
  476. #define RFLR_HOPCHANNEL_PLL_LOCK_SUCCEED 0x00 // Default
  477. #define RFLR_HOPCHANNEL_PAYLOAD_CRC16_MASK 0xBF
  478. #define RFLR_HOPCHANNEL_PAYLOAD_CRC16_ON 0x40
  479. #define RFLR_HOPCHANNEL_PAYLOAD_CRC16_OFF 0x00 // Default
  480. #define RFLR_HOPCHANNEL_CHANNEL_MASK 0x3F
  481. /*!
  482. * RegSymbTimeoutLsb
  483. */
  484. #define RFLR_SYMBTIMEOUTLSB_SYMBTIMEOUT 0x64 // Default
  485. /*!
  486. * RegPreambleLengthMsb
  487. */
  488. #define RFLR_PREAMBLELENGTHMSB 0x00 // Default
  489. /*!
  490. * RegPreambleLengthLsb
  491. */
  492. #define RFLR_PREAMBLELENGTHLSB 0x08 // Default
  493. /*!
  494. * RegPayloadLength
  495. */
  496. #define RFLR_PAYLOADLENGTH 0x0E // Default
  497. /*!
  498. * RegPayloadMaxLength
  499. */
  500. #define RFLR_PAYLOADMAXLENGTH 0xFF // Default
  501. /*!
  502. * RegHopPeriod
  503. */
  504. #define RFLR_HOPPERIOD_FREQFOPPINGPERIOD 0x00 // Default
  505. /*!
  506. * RegDioMapping1
  507. */
  508. #define RFLR_DIOMAPPING1_DIO0_MASK 0x3F
  509. #define RFLR_DIOMAPPING1_DIO0_00 0x00 // Default
  510. #define RFLR_DIOMAPPING1_DIO0_01 0x40
  511. #define RFLR_DIOMAPPING1_DIO0_10 0x80
  512. #define RFLR_DIOMAPPING1_DIO0_11 0xC0
  513. #define RFLR_DIOMAPPING1_DIO1_MASK 0xCF
  514. #define RFLR_DIOMAPPING1_DIO1_00 0x00 // Default
  515. #define RFLR_DIOMAPPING1_DIO1_01 0x10
  516. #define RFLR_DIOMAPPING1_DIO1_10 0x20
  517. #define RFLR_DIOMAPPING1_DIO1_11 0x30
  518. #define RFLR_DIOMAPPING1_DIO2_MASK 0xF3
  519. #define RFLR_DIOMAPPING1_DIO2_00 0x00 // Default
  520. #define RFLR_DIOMAPPING1_DIO2_01 0x04
  521. #define RFLR_DIOMAPPING1_DIO2_10 0x08
  522. #define RFLR_DIOMAPPING1_DIO2_11 0x0C
  523. #define RFLR_DIOMAPPING1_DIO3_MASK 0xFC
  524. #define RFLR_DIOMAPPING1_DIO3_00 0x00 // Default
  525. #define RFLR_DIOMAPPING1_DIO3_01 0x01
  526. #define RFLR_DIOMAPPING1_DIO3_10 0x02
  527. #define RFLR_DIOMAPPING1_DIO3_11 0x03
  528. /*!
  529. * RegDioMapping2
  530. */
  531. #define RFLR_DIOMAPPING2_DIO4_MASK 0x3F
  532. #define RFLR_DIOMAPPING2_DIO4_00 0x00 // Default
  533. #define RFLR_DIOMAPPING2_DIO4_01 0x40
  534. #define RFLR_DIOMAPPING2_DIO4_10 0x80
  535. #define RFLR_DIOMAPPING2_DIO4_11 0xC0
  536. #define RFLR_DIOMAPPING2_DIO5_MASK 0xCF
  537. #define RFLR_DIOMAPPING2_DIO5_00 0x00 // Default
  538. #define RFLR_DIOMAPPING2_DIO5_01 0x10
  539. #define RFLR_DIOMAPPING2_DIO5_10 0x20
  540. #define RFLR_DIOMAPPING2_DIO5_11 0x30
  541. #define RFLR_DIOMAPPING2_MAP_MASK 0xFE
  542. #define RFLR_DIOMAPPING2_MAP_PREAMBLEDETECT 0x01
  543. #define RFLR_DIOMAPPING2_MAP_RSSI 0x00 // Default
  544. /*!
  545. * RegVersion (Read Only)
  546. */
  547. /*!
  548. * RegAgcRef
  549. */
  550. /*!
  551. * RegAgcThresh1
  552. */
  553. /*!
  554. * RegAgcThresh2
  555. */
  556. /*!
  557. * RegAgcThresh3
  558. */
  559. /*!
  560. * RegFifoRxByteAddr (Read Only)
  561. */
  562. /*!
  563. * RegPllHop
  564. */
  565. #define RFLR_PLLHOP_FASTHOP_MASK 0x7F
  566. #define RFLR_PLLHOP_FASTHOP_ON 0x80
  567. #define RFLR_PLLHOP_FASTHOP_OFF 0x00 // Default
  568. /*!
  569. * RegTcxo
  570. */
  571. #define RFLR_TCXO_TCXOINPUT_MASK 0xEF
  572. #define RFLR_TCXO_TCXOINPUT_ON 0x10
  573. #define RFLR_TCXO_TCXOINPUT_OFF 0x00 // Default
  574. /*!
  575. * RegPaDac
  576. */
  577. #define RFLR_PADAC_20DBM_MASK 0xF8
  578. #define RFLR_PADAC_20DBM_ON 0x07
  579. #define RFLR_PADAC_20DBM_OFF 0x04 // Default
  580. /*!
  581. * RegPll
  582. */
  583. #define RFLR_PLL_BANDWIDTH_MASK 0x3F
  584. #define RFLR_PLL_BANDWIDTH_75 0x00
  585. #define RFLR_PLL_BANDWIDTH_150 0x40
  586. #define RFLR_PLL_BANDWIDTH_225 0x80
  587. #define RFLR_PLL_BANDWIDTH_300 0xC0 // Default
  588. /*!
  589. * RegPllLowPn
  590. */
  591. #define RFLR_PLLLOWPN_BANDWIDTH_MASK 0x3F
  592. #define RFLR_PLLLOWPN_BANDWIDTH_75 0x00
  593. #define RFLR_PLLLOWPN_BANDWIDTH_150 0x40
  594. #define RFLR_PLLLOWPN_BANDWIDTH_225 0x80
  595. #define RFLR_PLLLOWPN_BANDWIDTH_300 0xC0 // Default
  596. /*!
  597. * RegModemConfig3
  598. */
  599. #define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_MASK 0xF7
  600. #define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_ON 0x08
  601. #define RFLR_MODEMCONFIG3_LOWDATARATEOPTIMIZE_OFF 0x00 // Default
  602. #define RFLR_MODEMCONFIG3_AGCAUTO_MASK 0xFB
  603. #define RFLR_MODEMCONFIG3_AGCAUTO_ON 0x04 // Default
  604. #define RFLR_MODEMCONFIG3_AGCAUTO_OFF 0x00
  605. /*!
  606. * RegFormerTemp
  607. */
  608. typedef struct sSX1276LR
  609. {
  610. uint8_t RegFifo; // 0x00
  611. // Common settings
  612. uint8_t RegOpMode; // 0x01
  613. uint8_t RegRes02; // 0x02
  614. uint8_t RegRes03; // 0x03
  615. uint8_t RegBandSetting; // 0x04
  616. uint8_t RegRes05; // 0x05
  617. uint8_t RegFrfMsb; // 0x06
  618. uint8_t RegFrfMid; // 0x07
  619. uint8_t RegFrfLsb; // 0x08
  620. // Tx settings
  621. uint8_t RegPaConfig; // 0x09
  622. uint8_t RegPaRamp; // 0x0A
  623. uint8_t RegOcp; // 0x0B
  624. // Rx settings
  625. uint8_t RegLna; // 0x0C
  626. // LoRa registers
  627. uint8_t RegFifoAddrPtr; // 0x0D
  628. uint8_t RegFifoTxBaseAddr; // 0x0E
  629. uint8_t RegFifoRxBaseAddr; // 0x0F
  630. uint8_t RegFifoRxCurrentAddr; // 0x10
  631. uint8_t RegIrqFlagsMask; // 0x11
  632. uint8_t RegIrqFlags; // 0x12
  633. uint8_t RegNbRxBytes; // 0x13
  634. uint8_t RegRxHeaderCntValueMsb; // 0x14
  635. uint8_t RegRxHeaderCntValueLsb; // 0x15
  636. uint8_t RegRxPacketCntValueMsb; // 0x16
  637. uint8_t RegRxPacketCntValueLsb; // 0x17
  638. uint8_t RegModemStat; // 0x18
  639. uint8_t RegPktSnrValue; // 0x19
  640. uint8_t RegPktRssiValue; // 0x1A
  641. uint8_t RegRssiValue; // 0x1B
  642. uint8_t RegHopChannel; // 0x1C
  643. uint8_t RegModemConfig1; // 0x1D
  644. uint8_t RegModemConfig2; // 0x1E
  645. uint8_t RegSymbTimeoutLsb; // 0x1F
  646. uint8_t RegPreambleMsb; // 0x20
  647. uint8_t RegPreambleLsb; // 0x21
  648. uint8_t RegPayloadLength; // 0x22
  649. uint8_t RegMaxPayloadLength; // 0x23
  650. uint8_t RegHopPeriod; // 0x24
  651. uint8_t RegFifoRxByteAddr; // 0x25
  652. uint8_t RegModemConfig3; // 0x26
  653. uint8_t RegTestReserved27[0x30 - 0x27]; // 0x27-0x30
  654. uint8_t RegTestReserved31; // 0x31
  655. uint8_t RegTestReserved32[0x40 - 0x32]; // 0x32-0x40
  656. // I/O settings
  657. uint8_t RegDioMapping1; // 0x40
  658. uint8_t RegDioMapping2; // 0x41
  659. // Version
  660. uint8_t RegVersion; // 0x42
  661. // Additional settings
  662. uint8_t RegAgcRef; // 0x43
  663. uint8_t RegAgcThresh1; // 0x44
  664. uint8_t RegAgcThresh2; // 0x45
  665. uint8_t RegAgcThresh3; // 0x46
  666. // Test
  667. uint8_t RegTestReserved47[0x4B - 0x47]; // 0x47-0x4A
  668. // Additional settings
  669. uint8_t RegPllHop; // 0x4B
  670. uint8_t RegTestReserved4C; // 0x4C
  671. uint8_t RegPaDac; // 0x4D
  672. // Test
  673. uint8_t RegTestReserved4E[0x58-0x4E]; // 0x4E-0x57
  674. // Additional settings
  675. uint8_t RegTcxo; // 0x58
  676. // Test
  677. uint8_t RegTestReserved59; // 0x59
  678. // Test
  679. uint8_t RegTestReserved5B; // 0x5B
  680. // Additional settings
  681. uint8_t RegPll; // 0x5C
  682. // Test
  683. uint8_t RegTestReserved5D; // 0x5D
  684. // Additional settings
  685. uint8_t RegPllLowPn; // 0x5E
  686. // Test
  687. uint8_t RegTestReserved5F[0x6C - 0x5F]; // 0x5F-0x6B
  688. // Additional settings
  689. uint8_t RegFormerTemp; // 0x6C
  690. // Test
  691. uint8_t RegTestReserved6D[0x71 - 0x6D]; // 0x6D-0x70
  692. }tSX1276LR;
  693. extern tSX1276LR* SX1276LR;
  694. /*!
  695. * \brief Initializes the SX1276
  696. */
  697. void SX1276LoRaInit( void );
  698. /*!
  699. * \brief check SX1278 config
  700. */
  701. bool SX1276LoraConfigCheck(void);
  702. /*!
  703. * \brief Sets the SX1276 to datasheet default values
  704. */
  705. void SX1276LoRaSetDefaults( void );
  706. /*!
  707. * \brief Enables/Disables the LoRa modem
  708. *
  709. * \param [IN]: enable [true, false]
  710. */
  711. void SX1276LoRaSetLoRaOn( bool enable );
  712. /*!
  713. * \brief Sets the SX1276 operating mode
  714. *
  715. * \param [IN] opMode New operating mode
  716. */
  717. void SX1276LoRaSetOpMode( uint8_t opMode );
  718. /*!
  719. * \brief Gets the SX1276 operating mode
  720. *
  721. * \retval opMode Current operating mode
  722. */
  723. uint8_t SX1276LoRaGetOpMode( void );
  724. /*!
  725. * \brief Reads the current Rx gain setting
  726. *
  727. * \retval rxGain Current gain setting
  728. */
  729. uint8_t SX1276LoRaReadRxGain( void );
  730. /*!
  731. * \brief Trigs and reads the current RSSI value
  732. *
  733. * \retval rssiValue Current RSSI value in [dBm]
  734. */
  735. double SX1276LoRaReadRssi( void );
  736. /*!
  737. * \brief Gets the Rx gain value measured while receiving the packet
  738. *
  739. * \retval rxGainValue Current Rx gain value
  740. */
  741. uint8_t SX1276LoRaGetPacketRxGain( void );
  742. /*!
  743. * \brief Gets the SNR value measured while receiving the packet
  744. *
  745. * \retval snrValue Current SNR value in [dB]
  746. */
  747. int8_t SX1276LoRaGetPacketSnr( void );
  748. /*!
  749. * \brief Gets the RSSI value measured while receiving the packet
  750. *
  751. * \retval rssiValue Current RSSI value in [dBm]
  752. */
  753. double SX1276LoRaGetPacketRssi( void );
  754. /*!
  755. * \brief Sets the radio in Rx mode. Waiting for a packet
  756. */
  757. void SX1276LoRaStartRx( void );
  758. /*!
  759. * \brief Gets a copy of the current received buffer
  760. *
  761. * \param [IN]: buffer Buffer pointer
  762. * \param [IN]: size Buffer size
  763. */
  764. void SX1276LoRaGetRxPacket( void *buffer, uint16_t *size );
  765. /*!
  766. * \brief Sets a copy of the buffer to be transmitted
  767. *
  768. * \param [IN]: buffer Buffer pointer
  769. * \param [IN]: size Buffer size
  770. */
  771. void SX1276LoRaSetTxPacket( const void *buffer, uint16_t size );
  772. /*!
  773. * \brief Gets the current RFState
  774. *
  775. * \retval rfState Current RF state [RF_IDLE, RF_BUSY,
  776. * RF_RX_DONE, RF_RX_TIMEOUT,
  777. * RF_TX_DONE, RF_TX_TIMEOUT]
  778. */
  779. uint8_t SX1276LoRaGetRFState( void );
  780. /*!
  781. * \brief Sets the new state of the RF state machine
  782. *
  783. * \param [IN]: state New RF state machine state
  784. */
  785. void SX1276LoRaSetRFState( uint8_t state );
  786. /*!
  787. * \brief Process the LoRa modem Rx and Tx state machines depending on the
  788. * SX1276 operating mode.
  789. *
  790. * \retval rfState Current RF state [RF_IDLE, RF_BUSY,
  791. * RF_RX_DONE, RF_RX_TIMEOUT,
  792. * RF_TX_DONE, RF_TX_TIMEOUT]
  793. */
  794. uint32_t SX1276LoRaProcess( void );
  795. uint32_t SX1276GetLoraTimeOnAir(uint8_t pktLen );
  796. uint32_t SX1276GetLoraDataRate( void);
  797. uint32_t getRadom(void);
  798. //bool SX1276IsLoraChannelFree( int16_t rssiThresh );
  799. #endif //__SX1276_LORA_H__