SX128x.h

#if !defined(_RADIOLIB_SX128X_H)
#define _RADIOLIB_SX128X_H

#include "../../TypeDef.h"

#if !defined(RADIOLIB_EXCLUDE_SX128X)

#include "../../Module.h"

#include "../../protocols/PhysicalLayer/PhysicalLayer.h"

// SX128X physical layer properties
#define SX128X_FREQUENCY_STEP_SIZE                    198.3642578
#define SX128X_MAX_PACKET_LENGTH                      255
#define SX128X_CRYSTAL_FREQ                           52.0
#define SX128X_DIV_EXPONENT                           18

// SX128X SPI commands
#define SX128X_CMD_NOP                                0x00
#define SX128X_CMD_GET_STATUS                         0xC0
#define SX128X_CMD_WRITE_REGISTER                     0x18
#define SX128X_CMD_READ_REGISTER                      0x19
#define SX128X_CMD_WRITE_BUFFER                       0x1A
#define SX128X_CMD_READ_BUFFER                        0x1B
#define SX128X_CMD_SET_SLEEP                          0x84
#define SX128X_CMD_SET_STANDBY                        0x80
#define SX128X_CMD_SET_FS                             0xC1
#define SX128X_CMD_SET_TX                             0x83
#define SX128X_CMD_SET_RX                             0x82
#define SX128X_CMD_SET_RX_DUTY_CYCLE                  0x94
#define SX128X_CMD_SET_CAD                            0xC5
#define SX128X_CMD_SET_TX_CONTINUOUS_WAVE             0xD1
#define SX128X_CMD_SET_TX_CONTINUOUS_PREAMBLE         0xD2
#define SX128X_CMD_SET_PACKET_TYPE                    0x8A
#define SX128X_CMD_GET_PACKET_TYPE                    0x03
#define SX128X_CMD_SET_RF_FREQUENCY                   0x86
#define SX128X_CMD_SET_TX_PARAMS                      0x8E
#define SX128X_CMD_SET_CAD_PARAMS                     0x88
#define SX128X_CMD_SET_BUFFER_BASE_ADDRESS            0x8F
#define SX128X_CMD_SET_MODULATION_PARAMS              0x8B
#define SX128X_CMD_SET_PACKET_PARAMS                  0x8C
#define SX128X_CMD_GET_RX_BUFFER_STATUS               0x17
#define SX128X_CMD_GET_PACKET_STATUS                  0x1D
#define SX128X_CMD_GET_RSSI_INST                      0x1F
#define SX128X_CMD_SET_DIO_IRQ_PARAMS                 0x8D
#define SX128X_CMD_GET_IRQ_STATUS                     0x15
#define SX128X_CMD_CLEAR_IRQ_STATUS                   0x97
#define SX128X_CMD_SET_REGULATOR_MODE                 0x96
#define SX128X_CMD_SET_SAVE_CONTEXT                   0xD5
#define SX128X_CMD_SET_AUTO_TX                        0x98
#define SX128X_CMD_SET_AUTO_FS                        0x9E
#define SX128X_CMD_SET_PERF_COUNTER_MODE              0x9C
#define SX128X_CMD_SET_LONG_PREAMBLE                  0x9B
#define SX128X_CMD_SET_UART_SPEED                     0x9D
#define SX128X_CMD_SET_RANGING_ROLE                   0xA3
#define SX128X_CMD_SET_ADVANCED_RANGING               0x9A

// SX128X register map
#define SX128X_REG_SYNC_WORD_1_BYTE_4                 0x09CE
#define SX128X_REG_SYNC_WORD_1_BYTE_3                 0x09CF
#define SX128X_REG_SYNC_WORD_1_BYTE_2                 0x09D0
#define SX128X_REG_SYNC_WORD_1_BYTE_1                 0x09D1
#define SX128X_REG_SYNC_WORD_1_BYTE_0                 0x09D2
#define SX128X_REG_SYNC_WORD_2_BYTE_4                 0x09D3
#define SX128X_REG_SYNC_WORD_2_BYTE_3                 0x09D4
#define SX128X_REG_SYNC_WORD_2_BYTE_2                 0x09D5
#define SX128X_REG_SYNC_WORD_2_BYTE_1                 0x09D6
#define SX128X_REG_SYNC_WORD_2_BYTE_0                 0x09D7
#define SX128X_REG_SYNC_WORD_3_BYTE_4                 0x09D8
#define SX128X_REG_SYNC_WORD_3_BYTE_3                 0x09D9
#define SX128X_REG_SYNC_WORD_3_BYTE_2                 0x09DA
#define SX128X_REG_SYNC_WORD_3_BYTE_1                 0x09DB
#define SX128X_REG_SYNC_WORD_3_BYTE_0                 0x09DC
#define SX128X_REG_CRC_INITIAL_MSB                    0x09C8
#define SX128X_REG_CRC_INITIAL_LSB                    0x09C9
#define SX128X_REG_CRC_POLYNOMIAL_MSB                 0x09C6
#define SX128X_REG_CRC_POLYNOMIAL_LSB                 0x09C7
#define SX128X_REG_ACCESS_ADDRESS_BYTE_3              (SX128X_REG_SYNC_WORD_1_BYTE_3)
#define SX128X_REG_ACCESS_ADDRESS_BYTE_2              (SX128X_REG_SYNC_WORD_1_BYTE_2)
#define SX128X_REG_ACCESS_ADDRESS_BYTE_1              (SX128X_REG_SYNC_WORD_1_BYTE_1)
#define SX128X_REG_ACCESS_ADDRESS_BYTE_0              (SX128X_REG_SYNC_WORD_1_BYTE_0)
#define SX128X_REG_BLE_CRC_INITIAL_MSB                0x09C7
#define SX128X_REG_BLE_CRC_INITIAL_MID                (SX128X_REG_CRC_INITIAL_MSB)
#define SX128X_REG_BLE_CRC_INITIAL_LSB                (SX128X_REG_CRC_INITIAL_LSB)
#define SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_3       0x0916
#define SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_2       0x0917
#define SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_1       0x0918
#define SX128X_REG_SLAVE_RANGING_ADDRESS_BYTE_0       0x0919
#define SX128X_REG_SLAVE_RANGING_ADDRESS_WIDTH        0x0931
#define SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_3      0x0912
#define SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_2      0x0913
#define SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_1      0x0914
#define SX128X_REG_MASTER_RANGING_ADDRESS_BYTE_0      0x0915
#define SX128X_REG_RANGING_CALIBRATION_MSB            0x092C
#define SX128X_REG_RANGING_CALIBRATION_LSB            0x092D
#define SX128X_REG_RANGING_RESULT_MSB                 0x0961
#define SX128X_REG_RANGING_RESULT_MID                 0x0962
#define SX128X_REG_RANGING_RESULT_LSB                 0x0963
#define SX128X_REG_MANUAL_GAIN_CONTROL_ENABLE_1       0x089F
#define SX128X_REG_MANUAL_GAIN_CONTROL_ENABLE_2       0x0895
#define SX128X_REG_MANUAL_GAIN_SETTING                0x089E
#define SX128X_REG_GAIN_MODE                          0x0891
#define SX128X_REG_LORA_FIXED_PAYLOAD_LENGTH          0x0901
#define SX128X_REG_LORA_SF_CONFIG                     0x0925
#define SX128X_REG_FEI_MSB                            0x0954
#define SX128X_REG_FEI_MID                            0x0955
#define SX128X_REG_FEI_LSB                            0x0956
#define SX128X_REG_RANGING_FILTER_WINDOW_SIZE         0x091E
#define SX128X_REG_RANGING_FILTER_RSSI_OFFSET         0x0953
#define SX128X_REG_RANGING_FILTER_RESET               0x0923
#define SX128X_REG_RANGING_LORA_CLOCK_ENABLE          0x097F
#define SX128X_REG_RANGING_TYPE                       0x0924
#define SX128X_REG_RANGING_ADDRESS_SWITCH             0x0927
#define SX128X_REG_RANGING_ADDRESS_MSB                0x095F
#define SX128X_REG_RANGING_ADDRESS_LSB                0x0960


// SX128X SPI command variables
//SX128X_CMD_GET_STATUS                                               MSB   LSB   DESCRIPTION
#define SX128X_STATUS_MODE_STDBY_RC                   0b01000000  //  7     5     current chip mode: STDBY_RC
#define SX128X_STATUS_MODE_STDBY_XOSC                 0b01100000  //  7     5                        STDBY_XOSC
#define SX128X_STATUS_MODE_FS                         0b10000000  //  7     5                        FS
#define SX128X_STATUS_MODE_RX                         0b10100000  //  7     5                        Rx
#define SX128X_STATUS_MODE_TX                         0b11000000  //  7     5                        Tx
#define SX128X_STATUS_CMD_PROCESSED                   0b00000100  //  4     2     command status: processing OK
#define SX128X_STATUS_DATA_AVAILABLE                  0b00001000  //  4     2                     data available
#define SX128X_STATUS_CMD_TIMEOUT                     0b00001100  //  4     2                     timeout
#define SX128X_STATUS_CMD_ERROR                       0b00010000  //  4     2                     processing error
#define SX128X_STATUS_CMD_FAILED                      0b00010100  //  4     2                     failed to execute
#define SX128X_STATUS_TX_DONE                         0b00011000  //  4     2                     transmission finished
#define SX128X_STATUS_BUSY                            0b00000001  //  0     0     chip busy
#define SX128X_STATUS_SPI_FAILED                      0b11111111  //  7     0     SPI transaction failed

//SX128X_CMD_SET_SLEEP
#define SX128X_SLEEP_DATA_BUFFER_FLUSH                0b00000000  //  1     1     data buffer behavior in sleep mode: flush
#define SX128X_SLEEP_DATA_BUFFER_RETAIN               0b00000010  //  1     1                                         retain
#define SX128X_SLEEP_DATA_RAM_FLUSH                   0b00000000  //  0     0     data RAM (configuration) behavior in sleep mode: flush
#define SX128X_SLEEP_DATA_RAM_RETAIN                  0b00000001  //  0     0                                                      retain

//SX128X_CMD_SET_STANDBY
#define SX128X_STANDBY_RC                             0x00        //  7     0     standby mode: 13 MHz RC oscillator
#define SX128X_STANDBY_XOSC                           0x01        //  7     0                   52 MHz crystal oscillator

//SX128X_CMD_SET_TX + SX128X_CMD_SET_RX + SX128X_CMD_SET_RX_DUTY_CYCLE
#define SX128X_PERIOD_BASE_15_625_US                  0x00        //  7     0     time period step: 15.625 us
#define SX128X_PERIOD_BASE_62_5_US                    0x01        //  7     0                       62.5 us
#define SX128X_PERIOD_BASE_1_MS                       0x02        //  7     0                       1 ms
#define SX128X_PERIOD_BASE_4_MS                       0x03        //  7     0                       4 ms

//SX128X_CMD_SET_TX
#define SX128X_TX_TIMEOUT_NONE                        0x0000      //  15    0     Tx timeout duration: no timeout (Tx single mode)

//SX128X_CMD_SET_RX
#define SX128X_RX_TIMEOUT_NONE                        0x0000      //  15    0     Rx timeout duration: no timeout (Rx single mode)
#define SX128X_RX_TIMEOUT_INF                         0xFFFF      //  15    0                          infinite (Rx continuous mode)

//SX128X_CMD_SET_PACKET_TYPE
#define SX128X_PACKET_TYPE_GFSK                       0x00        //  7     0     packet type: (G)FSK
#define SX128X_PACKET_TYPE_LORA                       0x01        //  7     0                  LoRa
#define SX128X_PACKET_TYPE_RANGING                    0x02        //  7     0                  ranging engine
#define SX128X_PACKET_TYPE_FLRC                       0x03        //  7     0                  FLRC
#define SX128X_PACKET_TYPE_BLE                        0x04        //  7     0                  BLE

//SX128X_CMD_SET_TX_PARAMS
#define SX128X_PA_RAMP_02_US                          0x00        //  7     0     PA ramp time: 2 us
#define SX128X_PA_RAMP_04_US                          0x20        //  7     0                   4 us
#define SX128X_PA_RAMP_06_US                          0x40        //  7     0                   6 us
#define SX128X_PA_RAMP_08_US                          0x60        //  7     0                   8 us
#define SX128X_PA_RAMP_10_US                          0x80        //  7     0                   10 us
#define SX128X_PA_RAMP_12_US                          0xA0        //  7     0                   12 us
#define SX128X_PA_RAMP_16_US                          0xC0        //  7     0                   16 us
#define SX128X_PA_RAMP_20_US                          0xE0        //  7     0                   20 us

//SX128X_CMD_SET_CAD_PARAMS
#define SX128X_CAD_ON_1_SYMB                          0x00        //  7     0     number of symbols used for CAD: 1
#define SX128X_CAD_ON_2_SYMB                          0x20        //  7     0                                     2
#define SX128X_CAD_ON_4_SYMB                          0x40        //  7     0                                     4
#define SX128X_CAD_ON_8_SYMB                          0x60        //  7     0                                     8
#define SX128X_CAD_ON_16_SYMB                         0x80        //  7     0                                     16

//SX128X_CMD_SET_MODULATION_PARAMS
#define SX128X_BLE_GFSK_BR_2_000_BW_2_4               0x04        //  7     0     GFSK/BLE bit rate and bandwidth setting: 2.0 Mbps   2.4 MHz
#define SX128X_BLE_GFSK_BR_1_600_BW_2_4               0x28        //  7     0                                              1.6 Mbps   2.4 MHz
#define SX128X_BLE_GFSK_BR_1_000_BW_2_4               0x4C        //  7     0                                              1.0 Mbps   2.4 MHz
#define SX128X_BLE_GFSK_BR_1_000_BW_1_2               0x45        //  7     0                                              1.0 Mbps   1.2 MHz
#define SX128X_BLE_GFSK_BR_0_800_BW_2_4               0x70        //  7     0                                              0.8 Mbps   2.4 MHz
#define SX128X_BLE_GFSK_BR_0_800_BW_1_2               0x69        //  7     0                                              0.8 Mbps   1.2 MHz
#define SX128X_BLE_GFSK_BR_0_500_BW_1_2               0x8D        //  7     0                                              0.5 Mbps   1.2 MHz
#define SX128X_BLE_GFSK_BR_0_500_BW_0_6               0x86        //  7     0                                              0.5 Mbps   0.6 MHz
#define SX128X_BLE_GFSK_BR_0_400_BW_1_2               0xB1        //  7     0                                              0.4 Mbps   1.2 MHz
#define SX128X_BLE_GFSK_BR_0_400_BW_0_6               0xAA        //  7     0                                              0.4 Mbps   0.6 MHz
#define SX128X_BLE_GFSK_BR_0_250_BW_0_6               0xCE        //  7     0                                              0.25 Mbps  0.6 MHz
#define SX128X_BLE_GFSK_BR_0_250_BW_0_3               0xC7        //  7     0                                              0.25 Mbps  0.3 MHz
#define SX128X_BLE_GFSK_BR_0_125_BW_0_3               0xEF        //  7     0                                              0.125 Mbps 0.3 MHz
#define SX128X_BLE_GFSK_MOD_IND_0_35                  0x00        //  7     0     GFSK/BLE modulation index: 0.35
#define SX128X_BLE_GFSK_MOD_IND_0_50                  0x01        //  7     0                                0.50
#define SX128X_BLE_GFSK_MOD_IND_0_75                  0x02        //  7     0                                0.75
#define SX128X_BLE_GFSK_MOD_IND_1_00                  0x03        //  7     0                                1.00
#define SX128X_BLE_GFSK_MOD_IND_1_25                  0x04        //  7     0                                1.25
#define SX128X_BLE_GFSK_MOD_IND_1_50                  0x05        //  7     0                                1.50
#define SX128X_BLE_GFSK_MOD_IND_1_75                  0x06        //  7     0                                1.75
#define SX128X_BLE_GFSK_MOD_IND_2_00                  0x07        //  7     0                                2.00
#define SX128X_BLE_GFSK_MOD_IND_2_25                  0x08        //  7     0                                2.25
#define SX128X_BLE_GFSK_MOD_IND_2_50                  0x09        //  7     0                                2.50
#define SX128X_BLE_GFSK_MOD_IND_2_75                  0x0A        //  7     0                                2.75
#define SX128X_BLE_GFSK_MOD_IND_3_00                  0x0B        //  7     0                                3.00
#define SX128X_BLE_GFSK_MOD_IND_3_25                  0x0C        //  7     0                                3.25
#define SX128X_BLE_GFSK_MOD_IND_3_50                  0x0D        //  7     0                                3.50
#define SX128X_BLE_GFSK_MOD_IND_3_75                  0x0E        //  7     0                                3.75
#define SX128X_BLE_GFSK_MOD_IND_4_00                  0x0F        //  7     0                                4.00
#define SX128X_BLE_GFSK_BT_OFF                        0x00        //  7     0     GFSK Gaussian filter BT product: filter disabled
#define SX128X_BLE_GFSK_BT_1_0                        0x10        //  7     0                                      1.0
#define SX128X_BLE_GFSK_BT_0_5                        0x20        //  7     0                                      0.5
#define SX128X_FLRC_BR_1_300_BW_1_2                   0x45        //  7     0     FLRC bit rate and bandwidth setting: 1.3 Mbps   1.2 MHz
#define SX128X_FLRC_BR_1_000_BW_1_2                   0x69        //  7     0                                          1.04 Mbps  1.2 MHz
#define SX128X_FLRC_BR_0_650_BW_0_6                   0x86        //  7     0                                          0.65 Mbps  0.6 MHz
#define SX128X_FLRC_BR_0_520_BW_0_6                   0xAA        //  7     0                                          0.52 Mbps  0.6 MHz
#define SX128X_FLRC_BR_0_325_BW_0_3                   0xC7        //  7     0                                          0.325 Mbps 0.3 MHz
#define SX128X_FLRC_BR_0_260_BW_0_3                   0xEB        //  7     0                                          0.260 Mbps 0.3 MHz
#define SX128X_FLRC_CR_1_2                            0x00        //  7     0     FLRC coding rate: 1/2
#define SX128X_FLRC_CR_3_4                            0x02        //  7     0                       3/4
#define SX128X_FLRC_CR_1_0                            0x04        //  7     0                       1/1
#define SX128X_FLRC_BT_OFF                            0x00        //  7     0     FLRC Gaussian filter BT product: filter disabled
#define SX128X_FLRC_BT_1_0                            0x10        //  7     0                                      1.0
#define SX128X_FLRC_BT_0_5                            0x20        //  7     0                                      0.5
#define SX128X_LORA_SF_5                              0x50        //  7     0     LoRa spreading factor: 5
#define SX128X_LORA_SF_6                              0x60        //  7     0                            6
#define SX128X_LORA_SF_7                              0x70        //  7     0                            7
#define SX128X_LORA_SF_8                              0x80        //  7     0                            8
#define SX128X_LORA_SF_9                              0x90        //  7     0                            9
#define SX128X_LORA_SF_10                             0xA0        //  7     0                            10
#define SX128X_LORA_SF_11                             0xB0        //  7     0                            11
#define SX128X_LORA_SF_12                             0xC0        //  7     0                            12
#define SX128X_LORA_BW_1625_00                        0x0A        //  7     0     LoRa bandwidth: 1625.0 kHz
#define SX128X_LORA_BW_812_50                         0x18        //  7     0                     812.5 kHz
#define SX128X_LORA_BW_406_25                         0x26        //  7     0                     406.25 kHz
#define SX128X_LORA_BW_203_125                        0x34        //  7     0                     203.125 kHz
#define SX128X_LORA_CR_4_5                            0x01        //  7     0     LoRa coding rate: 4/5
#define SX128X_LORA_CR_4_6                            0x02        //  7     0                       4/6
#define SX128X_LORA_CR_4_7                            0x03        //  7     0                       4/7
#define SX128X_LORA_CR_4_8                            0x04        //  7     0                       4/8
#define SX128X_LORA_CR_4_5_LI                         0x05        //  7     0                       4/5, long interleaving
#define SX128X_LORA_CR_4_6_LI                         0x06        //  7     0                       4/6, long interleaving
#define SX128X_LORA_CR_4_7_LI                         0x07        //  7     0                       4/7, long interleaving

//SX128X_CMD_SET_PACKET_PARAMS
#define SX128X_GFSK_FLRC_SYNC_WORD_OFF                0x00        //  7     0     GFSK/FLRC sync word used: none
#define SX128X_GFSK_FLRC_SYNC_WORD_1                  0x10        //  7     0                               sync word 1
#define SX128X_GFSK_FLRC_SYNC_WORD_2                  0x20        //  7     0                               sync word 2
#define SX128X_GFSK_FLRC_SYNC_WORD_1_2                0x30        //  7     0                               sync words 1 and 2
#define SX128X_GFSK_FLRC_SYNC_WORD_3                  0x40        //  7     0                               sync word 3
#define SX128X_GFSK_FLRC_SYNC_WORD_1_3                0x50        //  7     0                               sync words 1 and 3
#define SX128X_GFSK_FLRC_SYNC_WORD_2_3                0x60        //  7     0                               sync words 2 and 3
#define SX128X_GFSK_FLRC_SYNC_WORD_1_2_3              0x70        //  7     0                               sync words 1, 2 and 3
#define SX128X_GFSK_FLRC_PACKET_FIXED                 0x00        //  7     0     GFSK/FLRC packet length mode: fixed
#define SX128X_GFSK_FLRC_PACKET_VARIABLE              0x20        //  7     0                                   variable
#define SX128X_GFSK_FLRC_CRC_OFF                      0x00        //  7     0     GFSK/FLRC packet CRC: none
#define SX128X_GFSK_FLRC_CRC_1_BYTE                   0x10        //  7     0                           1 byte
#define SX128X_GFSK_FLRC_CRC_2_BYTE                   0x20        //  7     0                           2 bytes
#define SX128X_GFSK_FLRC_CRC_3_BYTE                   0x30        //  7     0                           3 bytes (FLRC only)
#define SX128X_GFSK_BLE_WHITENING_ON                  0x00        //  7     0     GFSK/BLE whitening: enabled
#define SX128X_GFSK_BLE_WHITENING_OFF                 0x08        //  7     0                         disabled
#define SX128X_BLE_PAYLOAD_LENGTH_MAX_31              0x00        //  7     0     BLE maximum payload length: 31 bytes
#define SX128X_BLE_PAYLOAD_LENGTH_MAX_37              0x20        //  7     0                                 37 bytes
#define SX128X_BLE_PAYLOAD_LENGTH_TEST                0x40        //  7     0                                 63 bytes (test mode)
#define SX128X_BLE_PAYLOAD_LENGTH_MAX_255             0x80        //  7     0                                 255 bytes (Bluetooth 4.2 and above)
#define SX128X_BLE_CRC_OFF                            0x00        //  7     0     BLE packet CRC: none
#define SX128X_BLE_CRC_3_BYTE                         0x10        //  7     0                     3 byte
#define SX128X_BLE_PRBS_9                             0x00        //  7     0     BLE test payload contents: PRNG sequence using x^9 + x^5 + x
#define SX128X_BLE_EYELONG                            0x04        //  7     0                                repeated 0xF0
#define SX128X_BLE_EYESHORT                           0x08        //  7     0                                repeated 0xAA
#define SX128X_BLE_PRBS_15                            0x0C        //  7     0                                PRNG sequence using x^15 + x^14 + x^13 + x^12 + x^2 + x + 1
#define SX128X_BLE_ALL_1                              0x10        //  7     0                                repeated 0xFF
#define SX128X_BLE_ALL_0                              0x14        //  7     0                                repeated 0x00
#define SX128X_BLE_EYELONG_INV                        0x18        //  7     0                                repeated 0x0F
#define SX128X_BLE_EYESHORT_INV                       0x1C        //  7     0                                repeated 0x55
#define SX128X_FLRC_SYNC_WORD_OFF                     0x00        //  7     0     FLRC sync word: disabled
#define SX128X_FLRC_SYNC_WORD_ON                      0x04        //  7     0                     enabled
#define SX128X_LORA_HEADER_EXPLICIT                   0x00        //  7     0     LoRa header mode: explicit
#define SX128X_LORA_HEADER_IMPLICIT                   0x80        //  7     0                       implicit
#define SX128X_LORA_CRC_OFF                           0x00        //  7     0     LoRa packet CRC: disabled
#define SX128X_LORA_CRC_ON                            0x20        //  7     0                      enabled
#define SX128X_LORA_IQ_STANDARD                       0x40        //  7     0     LoRa IQ: standard
#define SX128X_LORA_IQ_INVERTED                       0x00        //  7     0              inverted

//SX128X_CMD_GET_PACKET_STATUS
#define SX128X_PACKET_STATUS_SYNC_ERROR               0b01000000  //  6     6     packet status errors byte: sync word error
#define SX128X_PACKET_STATUS_LENGTH_ERROR             0b00100000  //  5     5                                packet length error
#define SX128X_PACKET_STATUS_CRC_ERROR                0b00010000  //  4     4                                CRC error
#define SX128X_PACKET_STATUS_ABORT_ERROR              0b00001000  //  3     3                                packet reception aborted
#define SX128X_PACKET_STATUS_HEADER_RECEIVED          0b00000100  //  2     2                                header received
#define SX128X_PACKET_STATUS_PACKET_RECEIVED          0b00000010  //  1     1                                packet received
#define SX128X_PACKET_STATUS_PACKET_CTRL_BUSY         0b00000001  //  0     0                                packet controller is busy
#define SX128X_PACKET_STATUS_RX_PID                   0b11000000  //  7     6     packet status status byte: PID field of the received packet
#define SX128X_PACKET_STATUS_NO_ACK                   0b00100000  //  5     5                                NO_ACK field of the received packet
#define SX128X_PACKET_STATUS_RX_PID_ERROR             0b00010000  //  4     4                                PID field error
#define SX128X_PACKET_STATUS_PACKET_SENT              0b00000001  //  0     0                                packet sent
#define SX128X_PACKET_STATUS_SYNC_DET_ERROR           0b00000000  //  2     0     packet status sync byte: sync word detection error
#define SX128X_PACKET_STATUS_SYNC_DET_1               0b00000001  //  2     0                              detected sync word 1
#define SX128X_PACKET_STATUS_SYNC_DET_2               0b00000010  //  2     0                              detected sync word 2
#define SX128X_PACKET_STATUS_SYNC_DET_3               0b00000100  //  2     0                              detected sync word 3

//SX128X_CMD_SET_DIO_IRQ_PARAMS
#define SX128X_IRQ_PREAMBLE_DETECTED                  0x8000      //  15    15    interrupt source: preamble detected
#define SX128X_IRQ_ADVANCED_RANGING_DONE              0x8000      //  15    15                      advanced ranging done
#define SX128X_IRQ_RX_TX_TIMEOUT                      0x4000      //  14    14                      Rx or Tx timeout
#define SX128X_IRQ_CAD_DETECTED                       0x2000      //  13    13                      channel activity detected
#define SX128X_IRQ_CAD_DONE                           0x1000      //  12    12                      CAD finished
#define SX128X_IRQ_RANGING_SLAVE_REQ_VALID            0x0800      //  11    11                      ranging request valid (slave)
#define SX128X_IRQ_RANGING_MASTER_TIMEOUT             0x0400      //  10    10                      ranging timeout (master)
#define SX128X_IRQ_RANGING_MASTER_RES_VALID           0x0200      //  9     9                       ranging result valid (master)
#define SX128X_IRQ_RANGING_SLAVE_REQ_DISCARD          0x0100      //  8     8                       ranging result valid (master)
#define SX128X_IRQ_RANGING_SLAVE_RESP_DONE            0x0080      //  7     7                       ranging response complete (slave)
#define SX128X_IRQ_CRC_ERROR                          0x0040      //  6     6                       CRC error
#define SX128X_IRQ_HEADER_ERROR                       0x0020      //  5     5                       header error
#define SX128X_IRQ_HEADER_VALID                       0x0010      //  4     4                       header valid
#define SX128X_IRQ_SYNC_WORD_ERROR                    0x0008      //  3     3                       sync word error
#define SX128X_IRQ_SYNC_WORD_VALID                    0x0004      //  2     2                       sync word valid
#define SX128X_IRQ_RX_DONE                            0x0002      //  1     1                       Rx done
#define SX128X_IRQ_TX_DONE                            0x0001      //  0     0                       Tx done
#define SX128X_IRQ_NONE                               0x0000      //  15    0                       none
#define SX128X_IRQ_ALL                                0xFFFF      //  15    0                       all

//SX128X_CMD_SET_REGULATOR_MODE
#define SX128X_REGULATOR_LDO                          0x00        //  7     0     set regulator mode: LDO (default)
#define SX128X_REGULATOR_DC_DC                        0x01        //  7     0                         DC-DC

//SX128X_CMD_SET_RANGING_ROLE
#define SX128X_RANGING_ROLE_MASTER                    0x01        //  7     0     ranging role: master
#define SX128X_RANGING_ROLE_SLAVE                     0x00        //  7     0                   slave


class SX128x: public PhysicalLayer {
  public:
    // introduce PhysicalLayer overloads
    using PhysicalLayer::transmit;
    using PhysicalLayer::receive;
    using PhysicalLayer::startTransmit;
    using PhysicalLayer::readData;

    SX128x(Module* mod);

    // basic methods

    int16_t begin(float freq = 2400.0, float bw = 812.5, uint8_t sf = 9, uint8_t cr = 7, int8_t power = 10, uint16_t preambleLength = 12);

    int16_t beginGFSK(float freq = 2400.0, uint16_t br = 800, float freqDev = 400.0, int8_t power = 10, uint16_t preambleLength = 16);

    int16_t beginBLE(float freq = 2400.0, uint16_t br = 800, float freqDev = 400.0, int8_t power = 10, uint8_t dataShaping = RADIOLIB_SHAPING_0_5);

    int16_t beginFLRC(float freq = 2400.0, uint16_t br = 650, uint8_t cr = 3, int8_t power = 10, uint16_t preambleLength = 16, uint8_t dataShaping = RADIOLIB_SHAPING_0_5);

    int16_t reset(bool verify = true);

    int16_t transmit(uint8_t* data, size_t len, uint8_t addr = 0) override;

    int16_t receive(uint8_t* data, size_t len) override;

    int16_t transmitDirect(uint32_t frf = 0) override;

    int16_t receiveDirect() override;

    int16_t scanChannel();

    int16_t sleep(bool retainConfig = true);

    int16_t standby() override;

    int16_t standby(uint8_t mode);

    // interrupt methods

    void setDio1Action(void (*func)(void));

    void clearDio1Action();

    int16_t startTransmit(uint8_t* data, size_t len, uint8_t addr = 0) override;

    int16_t startReceive(uint16_t timeout = SX128X_RX_TIMEOUT_INF);

    int16_t readData(uint8_t* data, size_t len) override;

    // configuration methods

    int16_t setFrequency(float freq);

    int16_t setBandwidth(float bw);

    int16_t setSpreadingFactor(uint8_t sf);

    int16_t setCodingRate(uint8_t cr, bool longInterleaving = false);

    int16_t setOutputPower(int8_t power);

    int16_t setPreambleLength(uint32_t preambleLength);

    int16_t setBitRate(uint16_t br);

    int16_t setFrequencyDeviation(float freqDev) override;

    int16_t setDataShaping(uint8_t sh) override;

    int16_t setSyncWord(uint8_t* syncWord, uint8_t len);

    int16_t setCRC(uint8_t len, uint32_t initial = 0x1D0F, uint16_t polynomial = 0x1021);

    int16_t setWhitening(bool enabled);

    int16_t setAccessAddress(uint32_t addr);

    float getRSSI();

    float getSNR();

    size_t getPacketLength(bool update = true) override;

    uint32_t getTimeOnAir(size_t len);

    int16_t implicitHeader(size_t len);

    int16_t explicitHeader();

    int16_t setEncoding(uint8_t encoding) override;

    void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn);

    uint8_t random();

#ifndef RADIOLIB_GODMODE
  protected:
#endif
    Module* _mod;

    // cached LoRa parameters
    float _bwKhz = 0;
    uint8_t _bw = 0, _sf = 0, _cr = 0;
    uint8_t _preambleLengthLoRa = 0, _headerType = 0, _payloadLen = 0, _crcLoRa = 0;

    // SX128x SPI command implementations
    uint8_t getStatus();
    int16_t writeRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
    int16_t readRegister(uint16_t addr, uint8_t* data, uint8_t numBytes);
    int16_t writeBuffer(uint8_t* data, uint8_t numBytes, uint8_t offset = 0x00);
    int16_t readBuffer(uint8_t* data, uint8_t numBytes);
    int16_t setTx(uint16_t periodBaseCount = SX128X_TX_TIMEOUT_NONE, uint8_t periodBase = SX128X_PERIOD_BASE_15_625_US);
    int16_t setRx(uint16_t periodBaseCount, uint8_t periodBase = SX128X_PERIOD_BASE_15_625_US);
    int16_t setCad();
    uint8_t getPacketType();
    int16_t setRfFrequency(uint32_t frf);
    int16_t setTxParams(uint8_t power, uint8_t rampTime = SX128X_PA_RAMP_10_US);
    int16_t setBufferBaseAddress(uint8_t txBaseAddress = 0x00, uint8_t rxBaseAddress = 0x00);
    int16_t setModulationParams(uint8_t modParam1, uint8_t modParam2, uint8_t modParam3);
    int16_t setPacketParamsGFSK(uint8_t preambleLen, uint8_t syncWordLen, uint8_t syncWordMatch, uint8_t crcLen, uint8_t whitening, uint8_t payloadLen = 0xFF, uint8_t headerType = SX128X_GFSK_FLRC_PACKET_VARIABLE);
    int16_t setPacketParamsBLE(uint8_t connState, uint8_t crcLen, uint8_t bleTestPayload, uint8_t whitening);
    int16_t setPacketParamsLoRa(uint8_t preambleLen, uint8_t headerType, uint8_t payloadLen, uint8_t crc, uint8_t invertIQ = SX128X_LORA_IQ_STANDARD);
    int16_t setDioIrqParams(uint16_t irqMask, uint16_t dio1Mask, uint16_t dio2Mask = SX128X_IRQ_NONE, uint16_t dio3Mask = SX128X_IRQ_NONE);
    uint16_t getIrqStatus();
    int16_t clearIrqStatus(uint16_t clearIrqParams = SX128X_IRQ_ALL);
    int16_t setRangingRole(uint8_t role);
    int16_t setPacketType(uint8_t type);

    int16_t setHeaderType(uint8_t headerType, size_t len = 0xFF);

#ifndef RADIOLIB_GODMODE
  private:
#endif
    // common parameters
    uint8_t _pwr = 0;

    // cached GFSK parameters
    float _modIndexReal = 0;
    uint16_t _brKbps = 0;
    uint8_t _br = 0, _modIndex = 0, _shaping = 0;
    uint8_t _preambleLengthGFSK = 0, _syncWordLen = 0, _syncWordMatch = 0, _crcGFSK = 0, _whitening = 0;

    // cached FLRC parameters
    uint8_t _crFLRC = 0;

    // cached BLE parameters
    uint8_t _connectionState = 0, _crcBLE = 0, _bleTestPayload = 0;

    int16_t config(uint8_t modem);

    // common low-level SPI interface
    int16_t SPIwriteCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
    int16_t SPIwriteCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
    int16_t SPIreadCommand(uint8_t cmd, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
    int16_t SPIreadCommand(uint8_t* cmd, uint8_t cmdLen, uint8_t* data, uint8_t numBytes, bool waitForBusy = true);
    int16_t SPItransfer(uint8_t* cmd, uint8_t cmdLen, bool write, uint8_t* dataOut, uint8_t* dataIn, uint8_t numBytes, bool waitForBusy, uint32_t timeout = 5000);
};

#endif

#endif