24l01.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. #ifndef __24L01_H
  2. #define __24L01_H
  3. #include <stdbool.h>
  4. #include <stdint.h>
  5. //NRF24L01寄存器操作命令
  6. #define NRF_READ_REG 0x00 //读配置寄存器,低5位为寄存器地址
  7. #define NRF_WRITE_REG 0x20 //写配置寄存器,低5位为寄存器地址
  8. #define RD_RX_PLOAD 0x61 //读RX有效数据,1~32字节
  9. #define WR_TX_PLOAD 0xA0 //写TX有效数据,1~32字节
  10. #define FLUSH_TX 0xE1 //清除TX FIFO寄存器.发射模式下用
  11. #define FLUSH_RX 0xE2 //清除RX FIFO寄存器.接收模式下用
  12. #define REUSE_TX_PL 0xE3 //重新使用上一包数据,CE为高,数据包被不断发送.
  13. #define NOP 0xFF //空操作,可以用来读状态寄存器
  14. //SPI(NRF24L01)寄存器地址
  15. #define CONFIG 0x00 //配置寄存器地址;bit0:1接收模式,0发射模式;bit1:电选择;bit2:CRC模式;bit3:CRC使能;
  16. //bit4:中断MAX_RT(达到最大重发次数中断)使能;bit5:中断TX_DS使能;bit6:中断RX_DR使能
  17. #define EN_AA 0x01 //使能自动应答功能 bit0~5,对应通道0~5
  18. #define EN_RXADDR 0x02 //接收地址允许,bit0~5,对应通道0~5
  19. #define SETUP_AW 0x03 //设置地址宽度(所有数据通道):bit1,0:00,3字节;01,4字节;02,5字节;
  20. #define SETUP_RETR 0x04 //建立自动重发;bit3:0,自动重发计数器;bit7:4,自动重发延时 250*x+86us
  21. #define RF_CH 0x05 //RF通道,bit6:0,工作通道频率;2400+RF_CH【MHZ】
  22. #define RF_SETUP 0x06 //RF寄存器;bit3:传输速率(0:1Mbps,1:2Mbps);bit2:1,发射功率;bit0:低噪声放大器增益
  23. #define STATUS 0x07 //状态寄存器;bit0:TX FIFO满标志;bit3:1,接收数据通道号(最大:6);bit4,达到最多次重发
  24. //bit5:数据发送完成中断;bit6:接收数据中断;
  25. #define MAX_TX 0x10 //达到最大发送次数中断
  26. #define TX_OK 0x20 //TX发送完成中断
  27. #define RX_OK 0x40 //接收到数据中断
  28. #define OBSERVE_TX 0x08 //发送检测寄存器,bit7:4,数据包丢失计数器;bit3:0,重发计数器
  29. #define CD 0x09 //载波检测寄存器,bit0,载波检测;
  30. #define RX_ADDR_P0 0x0A //数据通道0接收地址,最大长度5个字节,低字节在前
  31. #define RX_ADDR_P1 0x0B //数据通道1接收地址,最大长度5个字节,低字节在前
  32. #define RX_ADDR_P2 0x0C //数据通道2接收地址,最低字节可设置,高字节,必须同RX_ADDR_P1[39:8]相等;
  33. #define RX_ADDR_P3 0x0D //数据通道3接收地址,最低字节可设置,高字节,必须同RX_ADDR_P1[39:8]相等;
  34. #define RX_ADDR_P4 0x0E //数据通道4接收地址,最低字节可设置,高字节,必须同RX_ADDR_P1[39:8]相等;
  35. #define RX_ADDR_P5 0x0F //数据通道5接收地址,最低字节可设置,高字节,必须同RX_ADDR_P1[39:8]相等;
  36. #define TX_ADDR 0x10 //发送地址(低字节在前),ShockBurstTM模式下,RX_ADDR_P0与此地址相等
  37. #define RX_PW_P0 0x11 //接收数据通道0有效数据宽度(1~32字节),设置为0则非法
  38. #define RX_PW_P1 0x12 //接收数据通道1有效数据宽度(1~32字节),设置为0则非法
  39. #define RX_PW_P2 0x13 //接收数据通道2有效数据宽度(1~32字节),设置为0则非法
  40. #define RX_PW_P3 0x14 //接收数据通道3有效数据宽度(1~32字节),设置为0则非法
  41. #define RX_PW_P4 0x15 //接收数据通道4有效数据宽度(1~32字节),设置为0则非法
  42. #define RX_PW_P5 0x16 //接收数据通道5有效数据宽度(1~32字节),设置为0则非法
  43. #define NRF_FIFO_STATUS 0x17 //FIFO状态寄存器;bit0,RX FIFO寄存器空标志;bit1,RX FIFO满标志;bit2,3,保留
  44. //bit4,TX FIFO空标志;bit5,TX FIFO满标志;bit6,1,循环发送上一数据包.0,不循环;
  45. #define FEATURE 0x1D
  46. #define DYNDP 0x1C
  47. #define MASK_CONFIG_RX_IRQ 0x40
  48. #define CONFIG_RX_IRQ_PIN 0x40
  49. #define MASK_CONFIG_TX_IRQ 0x20
  50. #define CONFIG_TX_IRQ_PIN 0x20
  51. #define MASK_CONFIG_MAX_IRQ 0x10
  52. #define CONFIG_MAX_IRQ_PIN 0x10
  53. #define MASK_CONFIG_EN_CRC 0x08
  54. #define CONFIG_EN_CRC 0x08
  55. #define CONFIG_DISEN_CRC 0x00
  56. #define MASK_CONFIG_CRC_BYTES 0x04
  57. #define CONFIG_CRC_BYTES_2BYTE 0x04
  58. #define CONFIG_CRC_BYTES_1BYTE 0x00
  59. #define MASK_CONFIG_PWR_UP 0x02
  60. #define CONFIG_PWR_UP_ON 0x02
  61. #define CONFIG_PWR_UP_OFF 0x00
  62. #define MASK_CONFIG_RF_MODE 0x01
  63. #define CONFIG_RF_MODE_RX 0x01
  64. #define CONFIG_RF_MODE_TX 0x00
  65. typedef enum
  66. {
  67. RF_PRIM_RX = 1,
  68. RF_PRIM_TX = 0,
  69. }rf_mode_te;
  70. #define MASK_SETUP_RETR_DELAY 0xf0
  71. #define MASK_SETUP_RETR_COUNT 0x0f
  72. #define MASK_RF_CH 0x7f
  73. #define MASK_RF_SETUP_CONT_WAVE 0x80
  74. #define MASK_RF_SETUP_RF_DR_LOW 0x20
  75. #define MASK_RF_SETUP_RF_DR_HIGH 0x08
  76. #define RF_SETUP_RF_DR_1Mbps 0x00
  77. #define RF_SETUP_RF_DR_2Mbps 0x08
  78. #define RF_SETUP_RF_DR_250Mbps 0x28
  79. #define MASK_RF_SETUP_RF_PWR 0x03
  80. #define RF_PWR_18N 0x00
  81. #define RF_PWR_12N 0x01
  82. #define RF_PWR_6N 0x02
  83. #define RF_PWR_0 0x03
  84. #define MASK_FEATURE 0x03
  85. #define FEATURE_EN_DPL 0x04
  86. #define FEATURE_EN_ACK_PAY 0x02
  87. #define FEATURE_EN_DYN_ACK 0x01
  88. //24L01发送接收数据宽度定义
  89. #define TX_ADR_WIDTH 5 //5字节的地址宽度
  90. #define RX_ADR_WIDTH 5 //5字节的地址宽度
  91. #define TX_PLOAD_WIDTH 32 //32字节的用户数据宽度
  92. #define RX_PLOAD_WIDTH 32 //32字节的用户数据宽度
  93. typedef void (*rf_callBack)(uint8_t *buf, uint16_t count);
  94. typedef union
  95. {
  96. uint8_t value;
  97. struct
  98. {
  99. /**
  100. * bit0
  101. * ...
  102. * bit7
  103. */
  104. // uint8_t obsolete : 1; //Don’t care
  105. uint8_t rf_pwr : 3; //R/W Set RF output power in TX mode
  106. // '00' – -18dBm
  107. // '01' – -12dBm
  108. // '10' – -6dBm
  109. // '11' – 0dBm
  110. // 111: 7dBm 110: 4dBm
  111. // 101: 3dBm 100: 1dBm
  112. // 011: 0dBm 010:-4dBm
  113. // 001:-6dBm 000:-12dBm
  114. uint8_t rf_dr_high : 1; //Select between the high speed data rates. This bit
  115. // is don’t care if RF_DR_LOW is set.
  116. // Encoding:
  117. // [RF_DR_LOW, RF_DR_HIGH]:
  118. // ‘00’ – 1Mbps
  119. // ‘01’ – 2Mbps
  120. // ‘10’ – 250kbps
  121. // ‘11’ – Reserved
  122. uint8_t pll_lock : 1; //Force PLL lock signal. Only used in test
  123. uint8_t rf_dr_low : 1; //R/W Set RF Data Rate to 250kbps. See RF_DR_HIGH
  124. // for encoding.
  125. uint8_t reserved : 1; //R/W Only '0' allowed
  126. uint8_t cont_wave : 1; //R/W Enables continuous carrier transmit when high
  127. }bits;
  128. }rf_setup_tu;
  129. typedef union
  130. {
  131. uint8_t value;
  132. struct
  133. {
  134. /**
  135. * bit0
  136. * ...
  137. * bit7
  138. */
  139. rf_mode_te prim_rx : 1; //RX/TX control
  140. // 1: PRX, 0: PTX
  141. uint8_t pwr_up : 1; //1: POWER UP, 0:POWER DOWN
  142. uint8_t crco : 1; //CRC encoding scheme
  143. // '0' - 1 byte
  144. // '1' – 2 bytes
  145. uint8_t enCrc : 1; //Enable CRC. Forced high if one of the bits in the
  146. // EN_AA is high
  147. uint8_t mask_max_rt : 1; //Mask interrupt caused by MAX_RT
  148. // 1: Interrupt not reflected on the IRQ pin
  149. // 0: Reflect MAX_RT as active low interrupt on the
  150. // IRQ pin
  151. uint8_t mask_tx_ds : 1; //Mask interrupt caused by TX_DS
  152. // 1: Interrupt not reflected on the IRQ pin
  153. // 0: Reflect TX_DS as active low interrupt on the IRQ
  154. // pin
  155. uint8_t mask_rx_dr : 1; // Mask interrupt caused by RX_DR
  156. // 1: Interrupt not reflected on the IRQ pin
  157. // 0: Reflect RX_DR as active low interrupt on the
  158. // IRQ pin
  159. uint8_t reserved : 1; //R/W Only '0' allowed
  160. }bits;
  161. }config_tu;
  162. typedef union
  163. {
  164. uint8_t value;
  165. struct
  166. {
  167. /**
  168. * bit0
  169. * ...
  170. * bit7
  171. */
  172. uint8_t tx_full : 1; //R TX FIFO full flag.
  173. // 1: TX FIFO full.
  174. // 0: Available locations in TX FIFO
  175. uint8_t rx_p_no : 3; //R Data pipe number for the payload available for
  176. // reading from RX_FIFO
  177. // 000-101: Data Pipe Number
  178. // 110: Not Used
  179. // 111: RX FIFO Empty
  180. uint8_t max_rt : 1; //R/W Maximum number of TX retransmits interrupt
  181. // Write 1 to clear bit. If MAX_RT is asserted it must
  182. // be cleared to enable further communication
  183. uint8_t tx_ds : 1; // Data Sent TX FIFO interrupt. Asserted when
  184. // packet transmitted on TX. If AUTO_ACK is activated,
  185. // this bit is set high only when ACK is
  186. // received.
  187. // Write 1 to clear bit.
  188. uint8_t rx_dr : 1; //Data Ready RX FIFO interrupt. Asserted when
  189. // new data arrives RX FIFOc.
  190. // Write 1 to clear bit
  191. uint8_t reserved : 1; //R/W Only '0' allowed
  192. }statusUint;
  193. }status_tu;
  194. typedef union
  195. {
  196. uint8_t setupRetrValue;
  197. struct
  198. {
  199. /**
  200. * bit0
  201. * ...
  202. * bit7
  203. */
  204. uint8_t arc : 4; //R/W Auto Retransmit Count
  205. // ‘0000’ –Re-Transmit disabled
  206. // ‘0001’ – Up to 1 Re-Transmit on fail of AA
  207. // ……
  208. // ‘1111’ – Up to 15 Re-Transmit on fail of AA
  209. uint8_t ard : 4; //Auto Retransmit Delay
  210. // ‘0000’ – Wait 250?S
  211. // ‘0001’ – Wait 500?S
  212. // ‘0010’ – Wait 750?S
  213. // ……..
  214. // ‘1111’ – Wait 4000?S
  215. // (Delay defined from end of transmission to start of
  216. // next transmission)b
  217. }bits;
  218. }setupRetr_tu;
  219. typedef union
  220. {
  221. uint8_t futureValue;
  222. struct
  223. {
  224. /**
  225. * bit0
  226. * ...
  227. * bit7
  228. */
  229. uint8_t en_dyn_ack : 1; //R/W Enables the W_TX_PAYLOAD_NOACK command
  230. uint8_t en_ack_pay : 1; //R/W Enables Payload with ACK
  231. uint8_t en_dpl : 1; //R/W Enables Dynamic Payload Length
  232. uint8_t receved : 5; //R/W Only ‘00000’ allowed
  233. }bits;
  234. }future_tu;
  235. typedef struct
  236. {
  237. uint8_t isValid;
  238. uint8_t len;
  239. uint8_t package[RX_PLOAD_WIDTH];
  240. }rfPackage_ts;
  241. int NRF24L01_Init(void);
  242. uint8_t NRF24L01_Check(void);
  243. void NRF24L01_TxPacket(uint8_t *txbuf, uint16_t len);
  244. void NRF24L01_getRxPacket(uint8_t *rxbuf, uint16_t len);
  245. void NRF24L01_WriteStrobe(uint8_t strobe);
  246. void NRF24L01_setChannl(uint8_t ch);
  247. void NRF24L01_setRfPower(uint8_t power);
  248. void NRF24L01_setRfBaudrate(uint32_t br);
  249. void NRF24L01_RfMode(uint8_t mode);
  250. void NRF24L01_carrierWave(void);
  251. void NRF24L01_powerDown(void);
  252. status_tu NRF24L01_readStatus(void);
  253. int8_t NRF24L01_getRssi(void);
  254. #endif