nrf_to_nrf - NRF52 Radio Driver v1.2.2
TMRh20 2023 - OSI Layer 2 radio driver using RF24 API
Loading...
Searching...
No Matches
nrf_to_nrf.h
Go to the documentation of this file.
1
7#ifndef __nrf52840_nrf24l01_H__
8#define __nrf52840_nrf24l01_H__
9#include <Arduino.h>
10#if defined(USE_TINYUSB)
11 // Needed for Serial.print on non-MBED enabled or adafruit-based nRF52 cores
12 #include "Adafruit_TinyUSB.h"
13#endif
14
15#if defined(NRF52811_XXAA) || defined(NRF52820_XXAA) || defined(NRF52833_XXAA) || defined(NRF52840_XXAA)
16 #define NRF_HAS_ENERGY_DETECT
17#endif
18
19#define NRF52_RADIO_LIBRARY
20#define DEFAULT_MAX_PAYLOAD_SIZE 32
21#define ACTUAL_MAX_PAYLOAD_SIZE 258
22#define ACK_TIMEOUT_1MBPS 600 // 300 with static payloads
23#define ACK_TIMEOUT_2MBPS 400 // 265 with static payloads
24#define ACK_TIMEOUT_250KBPS 800 // 500 with staticPayloads
25#define ACK_TIMEOUT_1MBPS_OFFSET 300
26#define ACK_TIMEOUT_2MBPS_OFFSET 135
27#define ACK_TIMEOUT_250KBPS_OFFSET 300
28#define ACK_PAYLOAD_TIMEOUT_OFFSET 750
29
30// AES CCM ENCRYPTION
31// The nRF54L15 CCM is a different peripheral with no NRF_CCM; with the nrf54l15clean core
32// (https://github.com/lolren/nrf54-arduino-core) encryption uses its Ccm and CracenRng classes
33#if defined(ARDUINO_NRF54L15) && defined(ARDUINO_ARCH_NRF54L15CLEAN)
34 #define NRF54_CCM_ENCRYPTION
35#endif
36#if defined NRF_CCM || defined NRF54_CCM_ENCRYPTION || defined(DOXYGEN)
37 #define CCM_ENCRYPTION_ENABLED
38#endif
39#if defined CCM_ENCRYPTION_ENABLED || defined(DOXYGEN)
40 #define MAX_PACKET_SIZE ACTUAL_MAX_PAYLOAD_SIZE // Max Payload Size
41 #define CCM_KEY_SIZE 16
42 #define CCM_IV_SIZE 5
43 #define CCM_IV_SIZE_ACTUAL 8
44 #define CCM_COUNTER_SIZE 3
45 #define CCM_MIC_SIZE 4
46 #define CCM_START_SIZE 3
47 #define CCM_MODE_LENGTH_EXTENDED 16
48#endif
49
87
96typedef enum
97{
104#ifdef ARDUINO_NRF54L15
106 ,
107 NRF_4MBPS_OBT4,
109 NRF_4MBPS_OBT6
110#endif
112
135
140
142{
143
144public:
151
159 nrf_to_nrf();
160
178 bool begin();
179
197 bool available();
198
215 bool available(uint8_t* pipe_num);
216
235 void read(void* buf, uint8_t len);
236
260 bool write(void* buf, uint8_t len, bool multicast = false, bool doEncryption = true);
261
281 void startListening(bool resetAddresses = true);
282
298 void stopListening(bool setWritingPipe = true, bool resetAddresses = true);
299
307 void stopListening(const uint8_t* txAddress, bool setWritingPipe = true, bool resetAddresses = true);
308
322 bool enableRxInterrupt(uint8_t depth = 3);
323
330 void disableRxInterrupt();
331
333 void handleInterrupt();
334
361 void openReadingPipe(uint8_t child, const uint8_t* address);
362
384 void openWritingPipe(const uint8_t* address);
385
392 bool isChipConnected();
393
401
409
419 bool writeFast(void* buf, uint8_t len, bool multicast = 0);
420
432 bool startWrite(void* buf, uint8_t len, bool multicast, bool doEncryption = true);
433
463 bool writeAckPayload(uint8_t pipe, void* buf, uint8_t len);
464
481 void enableAckPayload();
482
489 void disableAckPayload();
490
494 void enableDynamicAck();
495
506 uint8_t getDynamicPayloadSize();
507
512 bool isValid();
513
522 void setChannel(uint8_t channel, bool map = 0);
523
528 uint8_t getChannel();
529
544 bool setDataRate(uint8_t speed);
545
558 void setPALevel(uint8_t level, bool lnaEnable = true);
559
565 uint8_t getPALevel();
566
582 void setAutoAck(bool enable);
583
597 void setAutoAck(uint8_t pipe, bool enable);
598
609 void enableDynamicPayloads(uint8_t payloadSize = DEFAULT_MAX_PAYLOAD_SIZE);
610
617
628 void setPayloadSize(uint8_t size);
629
634 uint8_t getPayloadSize();
635
649 void setCRCLength(nrf_crclength_e length);
650
656
660 void disableCRC();
661
671 void setRetries(uint8_t retryVar, uint8_t attempts);
672
685 void openReadingPipe(uint8_t child, uint64_t address);
686
696 void openWritingPipe(uint64_t address);
697
704 void setAddressWidth(uint8_t a_width);
705
709 void printDetails();
710
718 void powerUp();
719
727 void powerDown();
728
733
741 bool txStandBy();
742
749 bool txStandBy(uint32_t timeout, bool startTx = 0);
750
765 bool testCarrier(uint8_t RSSI = 65);
766
772 bool testRPD(uint8_t RSSI = 65);
773
781 uint8_t getRSSI();
782
789 uint8_t getARC();
790
795 uint8_t flush_rx();
796
804 uint8_t flush_tx();
805
817
818#ifdef NRF_HAS_ENERGY_DETECT
823 uint8_t sample_ed(void);
824#endif
825
833
837 uint32_t addrConv32(uint32_t addr);
838#if defined CCM_ENCRYPTION_ENABLED || defined(DOXYGEN)
839
845 uint8_t encrypt(void* bufferIn, uint8_t size);
846
852 uint8_t decrypt(void* bufferIn, uint8_t size);
853
858
862 void setKey(uint8_t key[CCM_KEY_SIZE]);
863
867 void setCounter(uint64_t counter);
868
874 void setIV(uint8_t IV[CCM_IV_SIZE]);
875
892#endif
893
894private:
895 bool acksEnabled(uint8_t pipe);
896 bool acksPerPipe[8];
897 uint8_t retries;
898 uint8_t retryDuration;
899 uint8_t rxBuffer[ACTUAL_MAX_PAYLOAD_SIZE + 1];
900 uint8_t ackBuffer[ACTUAL_MAX_PAYLOAD_SIZE + 1];
901 uint8_t rxFifoAvailable;
902 bool DPL;
903 bool ackPayloadsEnabled;
904 volatile bool inRxMode;
905 uint8_t staticPayloadSize;
906 uint8_t ackPID;
907 uint8_t ackPipe;
908 bool lastTxResult;
909 uint32_t rxBase;
910 uint32_t rxPrefix;
911 uint32_t txBase;
912 uint32_t txPrefix;
913 volatile bool ackPayloadAvailable;
914 uint8_t ackAvailablePipeNo;
915 uint8_t lastPacketCounter;
916 uint16_t lastData;
917 bool dynamicAckEnabled;
918 uint8_t arcCounter;
919 uint16_t ackTimeout;
920 volatile bool payloadAvailable;
921 bool restartReturnRx();
922 void openReadingPipe(uint8_t child, uint32_t base, uint32_t prefix);
923 void openWritingPipe(uint32_t base, uint32_t prefix);
924 bool pollRadio(uint8_t* pipe_num);
925 uint8_t* rxQueueFront();
926 uint8_t* rxQueue;
927 uint16_t rxQueueSlotSize;
928 uint8_t rxQueueSlots;
929 volatile uint8_t rxQueueHead;
930 volatile uint8_t rxQueueTail;
931 uint8_t* ackQueue;
932 uint16_t ackQueueSlotSize;
933 uint8_t ackQueueDepth;
934 volatile uint8_t ackQueueHead;
935 volatile uint8_t ackQueueCount;
936 bool ackPayloadSent;
937 void loadAckPayload(uint8_t pipe);
938 void allocateAckQueue();
939 bool inInterrupt;
940 void resizeRxQueue();
941 void setStaticLength(uint8_t size);
942#if defined CCM_ENCRYPTION_ENABLED
943 uint8_t inBuffer[MAX_PACKET_SIZE + CCM_MIC_SIZE + CCM_START_SIZE];
944 uint8_t scratchPTR[MAX_PACKET_SIZE + CCM_MODE_LENGTH_EXTENDED];
945 typedef struct
946 {
947 uint8_t key[CCM_KEY_SIZE];
948 uint64_t counter;
949 uint8_t direction;
950 uint8_t iv[CCM_IV_SIZE_ACTUAL];
951 } ccmData_t;
952 ccmData_t ccmData;
953 uint32_t packetCounter;
954 bool generateIV(uint8_t iv[CCM_IV_SIZE]);
955#endif
956};
957
967
971
975
979
983
987
991
995
999
1003
1007
1011
1015
1019
1020#endif //__nrf52840_nrf24l01_H__
void startListening(bool resetAddresses=true)
void openReadingPipe(uint8_t child, const uint8_t *address)
bool available()
void setPALevel(uint8_t level, bool lnaEnable=true)
void disableRxInterrupt()
bool testCarrier(uint8_t RSSI=65)
bool txStandBy()
uint8_t flush_tx()
uint8_t decrypt(void *bufferIn, uint8_t size)
uint8_t radioData[ACTUAL_MAX_PAYLOAD_SIZE+2]
Definition nrf_to_nrf.h:408
uint32_t addrConv32(uint32_t addr)
void disableDynamicPayloads()
bool write(void *buf, uint8_t len, bool multicast=false, bool doEncryption=true)
bool testRPD(uint8_t RSSI=65)
void setCounter(uint64_t counter)
bool isChipConnected()
void setAddressWidth(uint8_t a_width)
void setChannel(uint8_t channel, bool map=0)
uint8_t getDynamicPayloadSize()
bool setDataRate(uint8_t speed)
void enableDynamicAck()
void setKey(uint8_t key[CCM_KEY_SIZE])
bool writeAckPayload(uint8_t pipe, void *buf, uint8_t len)
bool enableEncryption
Definition nrf_to_nrf.h:890
void enableDynamicPayloads(uint8_t payloadSize=DEFAULT_MAX_PAYLOAD_SIZE)
void handleInterrupt()
void disableAckPayload()
void disableCRC()
void powerDown()
uint8_t getARC()
uint8_t flush_rx()
uint8_t encrypt(void *bufferIn, uint8_t size)
void printDetails()
uint8_t getChannel()
bool startWrite(void *buf, uint8_t len, bool multicast, bool doEncryption=true)
uint8_t getRSSI()
uint16_t interframeSpacing
Definition nrf_to_nrf.h:816
uint8_t outBuffer[MAX_PACKET_SIZE+CCM_MIC_SIZE+CCM_START_SIZE]
Definition nrf_to_nrf.h:857
void setRetries(uint8_t retryVar, uint8_t attempts)
void enableAckPayload()
void openWritingPipe(const uint8_t *address)
void setCRCLength(nrf_crclength_e length)
bool failureDetected
Definition nrf_to_nrf.h:732
bool writeFast(void *buf, uint8_t len, bool multicast=0)
uint8_t getPALevel()
void setAutoAck(bool enable)
void read(void *buf, uint8_t len)
void stopListening(bool setWritingPipe=true, bool resetAddresses=true)
bool enableRxInterrupt(uint8_t depth=3)
void setIV(uint8_t IV[CCM_IV_SIZE])
void setPayloadSize(uint8_t size)
nrf_crclength_e getCRCLength()
uint8_t getPayloadSize()
#define CCM_MODE_LENGTH_EXTENDED
Definition nrf_to_nrf.h:47
#define DEFAULT_MAX_PAYLOAD_SIZE
Definition nrf_to_nrf.h:20
nrf_pa_dbm_e
Definition nrf_to_nrf.h:65
@ NRF_PA_MAX
Definition nrf_to_nrf.h:81
@ NRF_PA_HIGH
Definition nrf_to_nrf.h:77
@ NRF_PA_LOW
Definition nrf_to_nrf.h:73
@ NRF_PA_MIN
Definition nrf_to_nrf.h:69
@ NRF_PA_ERROR
Definition nrf_to_nrf.h:85
nrf_crclength_e
Definition nrf_to_nrf.h:125
@ NRF_CRC_8
Definition nrf_to_nrf.h:129
@ NRF_CRC_24
Definition nrf_to_nrf.h:133
@ NRF_CRC_DISABLED
Definition nrf_to_nrf.h:127
@ NRF_CRC_16
Definition nrf_to_nrf.h:131
#define CCM_IV_SIZE_ACTUAL
Definition nrf_to_nrf.h:43
nrf_datarate_e
Definition nrf_to_nrf.h:97
@ NRF_1MBPS
Definition nrf_to_nrf.h:99
@ NRF_2MBPS
Definition nrf_to_nrf.h:101
@ NRF_250KBPS
Definition nrf_to_nrf.h:103
#define CCM_START_SIZE
Definition nrf_to_nrf.h:46
#define ACTUAL_MAX_PAYLOAD_SIZE
Definition nrf_to_nrf.h:21
#define MAX_PACKET_SIZE
Definition nrf_to_nrf.h:40
#define CCM_MIC_SIZE
Definition nrf_to_nrf.h:45
#define CCM_KEY_SIZE
Definition nrf_to_nrf.h:41
#define CCM_IV_SIZE
Definition nrf_to_nrf.h:42