kopia lustrzana https://github.com/jgromes/RadioLib
345 wiersze
12 KiB
C++
345 wiersze
12 KiB
C++
#if !defined(_RADIOLIB_HAL_H)
|
|
#define _RADIOLIB_HAL_H
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
#include "BuildOpt.h"
|
|
|
|
#define RADIOLIB_EEPROM_TABLE_VERSION (0x0002)
|
|
|
|
// list of persistent parameters
|
|
enum RADIOLIB_EEPROM_PARAMS {
|
|
RADIOLIB_EEPROM_TABLE_VERSION_ID, // table layout version
|
|
RADIOLIB_EEPROM_LORAWAN_CLASS_ID, // class A, B or C
|
|
RADIOLIB_EEPROM_LORAWAN_MODE_ID, // none, OTAA or ABP
|
|
RADIOLIB_EEPROM_LORAWAN_CHECKSUM_ID, // checksum of keys used for device activation
|
|
RADIOLIB_EEPROM_LORAWAN_VERSION_ID, // LoRaWAN version
|
|
RADIOLIB_EEPROM_LORAWAN_LAST_TIME_ID, // last heard time through DeviceTimeReq or Beacon
|
|
RADIOLIB_EEPROM_LORAWAN_DEV_ADDR_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_APP_S_KEY_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_FNWK_SINT_KEY_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_SNWK_SINT_KEY_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_NWK_SENC_KEY_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_DEV_NONCE_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_JOIN_NONCE_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_HOME_NET_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_A_FCNT_DOWN_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_N_FCNT_DOWN_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_UP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_DOWN_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_ADR_FCNT_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_RJ_COUNT0_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_RJ_COUNT1_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_FCNT_UP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_LINK_ADR_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_DUTY_CYCLE_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_RX_PARAM_SETUP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_RX_TIMING_SETUP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_TX_PARAM_SETUP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_ADR_PARAM_SETUP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_REJOIN_PARAM_SETUP_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_BEACON_FREQ_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_PING_SLOT_CHANNEL_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_PERIODICITY_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_NUM_ADR_MASKS_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_MAC_QUEUE_UL_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_UL_CHANNELS_ID,
|
|
RADIOLIB_EEPROM_LORAWAN_DL_CHANNELS_ID
|
|
};
|
|
|
|
static const uint32_t RadioLibPersistentParamTable[] = {
|
|
0x00, // RADIOLIB_EEPROM_TABLE_VERSION_ID
|
|
0x02, // RADIOLIB_EEPROM_LORAWAN_CLASS_ID
|
|
0x03, // RADIOLIB_EEPROM_LORAWAN_MODE_ID
|
|
0x05, // RADIOLIB_EEPROM_LORAWAN_CHECKSUM_ID
|
|
0x07, // RADIOLIB_EEPROM_LORAWAN_VERSION_ID
|
|
0x08, // RADIOLIB_EEPROM_LORAWAN_LAST_TIME_ID
|
|
0x0C, // RADIOLIB_EEPROM_LORAWAN_DEV_ADDR_ID
|
|
0x10, // RADIOLIB_EEPROM_LORAWAN_APP_S_KEY_ID
|
|
0x20, // RADIOLIB_EEPROM_LORAWAN_FNWK_SINT_KEY_ID
|
|
0x30, // RADIOLIB_EEPROM_LORAWAN_SNWK_SINT_KEY_ID
|
|
0x40, // RADIOLIB_EEPROM_LORAWAN_NWK_SENC_KEY_ID
|
|
0x50, // RADIOLIB_EEPROM_LORAWAN_DEV_NONCE_ID
|
|
0x54, // RADIOLIB_EEPROM_LORAWAN_JOIN_NONCE_ID
|
|
0x58, // RADIOLIB_EEPROM_LORAWAN_HOME_NET_ID
|
|
0x5C, // RADIOLIB_EEPROM_LORAWAN_A_FCNT_DOWN_ID
|
|
0x60, // RADIOLIB_EEPROM_LORAWAN_N_FCNT_DOWN_ID
|
|
0x64, // RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_UP_ID
|
|
0x68, // RADIOLIB_EEPROM_LORAWAN_CONF_FCNT_DOWN_ID
|
|
0x6C, // RADIOLIB_EEPROM_LORAWAN_ADR_FCNT_ID
|
|
0x70, // RADIOLIB_EEPROM_LORAWAN_RJ_COUNT0_ID
|
|
0x72, // RADIOLIB_EEPROM_LORAWAN_RJ_COUNT1_ID
|
|
0x74, // RADIOLIB_EEPROM_LORAWAN_FCNT_UP_ID
|
|
0xA0, // RADIOLIB_EEPROM_LORAWAN_LINK_ADR_ID
|
|
0xA4, // RADIOLIB_EEPROM_LORAWAN_DUTY_CYCLE_ID
|
|
0xA5, // RADIOLIB_EEPROM_LORAWAN_RX_PARAM_SETUP_ID
|
|
0xA9, // RADIOLIB_EEPROM_LORAWAN_RX_TIMING_SETUP_ID
|
|
0xAA, // RADIOLIB_EEPROM_LORAWAN_TX_PARAM_SETUP_ID
|
|
0xAB, // RADIOLIB_EEPROM_LORAWAN_ADR_PARAM_SETUP_ID
|
|
0xAC, // RADIOLIB_EEPROM_LORAWAN_REJOIN_PARAM_SETUP_ID
|
|
0xAD, // RADIOLIB_EEPROM_LORAWAN_BEACON_FREQ_ID
|
|
0xB0, // RADIOLIB_EEPROM_LORAWAN_PING_SLOT_CHANNEL_ID
|
|
0xB4, // RADIOLIB_EEPROM_LORAWAN_PERIODICITY_ID
|
|
0xB5, // RADIOLIB_EEPROM_LORAWAN_NUM_ADR_MASKS_ID
|
|
0xB6, // RADIOLIB_EEPROM_LORAWAN_MAC_QUEUE_UL_ID
|
|
0x0100, // RADIOLIB_EEPROM_LORAWAN_UL_CHANNELS_ID
|
|
0x0180, // RADIOLIB_EEPROM_LORAWAN_DL_CHANNELS_ID
|
|
0x01C0, // end
|
|
};
|
|
|
|
/*!
|
|
\class RadioLibHal
|
|
\brief Hardware abstraction library base interface.
|
|
*/
|
|
class RadioLibHal {
|
|
public:
|
|
|
|
// values for pin modes, levels and change directions
|
|
// these tell RadioLib how are different logic states represented on a given platform
|
|
|
|
/*!
|
|
\brief Value to be used as the "input" GPIO direction.
|
|
*/
|
|
const uint32_t GpioModeInput;
|
|
|
|
/*!
|
|
\brief Value to be used as the "output" GPIO direction.
|
|
*/
|
|
const uint32_t GpioModeOutput;
|
|
|
|
/*!
|
|
\brief Value to be used as the "low" GPIO level.
|
|
*/
|
|
const uint32_t GpioLevelLow;
|
|
|
|
/*!
|
|
\brief Value to be used as the "high" GPIO level.
|
|
*/
|
|
const uint32_t GpioLevelHigh;
|
|
|
|
/*!
|
|
\brief Value to be used as the "rising" GPIO level change direction.
|
|
*/
|
|
const uint32_t GpioInterruptRising;
|
|
|
|
/*!
|
|
\brief Value to be used as the "falling" GPIO level change direction.
|
|
*/
|
|
const uint32_t GpioInterruptFalling;
|
|
|
|
/*!
|
|
\brief Default constructor.
|
|
\param input Value to be used as the "input" GPIO direction.
|
|
\param output Value to be used as the "output" GPIO direction.
|
|
\param low Value to be used as the "low" GPIO level.
|
|
\param high Value to be used as the "high" GPIO level.
|
|
\param rising Value to be used as the "rising" GPIO level change direction.
|
|
\param falling Value to be used as the "falling" GPIO level change direction.
|
|
*/
|
|
RadioLibHal(const uint32_t input, const uint32_t output, const uint32_t low, const uint32_t high, const uint32_t rising, const uint32_t falling);
|
|
|
|
// pure virtual methods - these must be implemented by the hardware abstraction for RadioLib to function
|
|
|
|
/*!
|
|
\brief GPIO pin mode (input/output/...) configuration method.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param pin Pin to be changed (platform-specific).
|
|
\param mode Mode to be set (platform-specific).
|
|
*/
|
|
virtual void pinMode(uint32_t pin, uint32_t mode) = 0;
|
|
|
|
/*!
|
|
\brief Digital write method.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param pin Pin to be changed (platform-specific).
|
|
\param value Value to set (platform-specific).
|
|
*/
|
|
virtual void digitalWrite(uint32_t pin, uint32_t value) = 0;
|
|
|
|
/*!
|
|
\brief Digital read method.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param pin Pin to be changed (platform-specific).
|
|
\returns Value read on the pin (platform-specific).
|
|
*/
|
|
virtual uint32_t digitalRead(uint32_t pin) = 0;
|
|
|
|
/*!
|
|
\brief Method to attach function to an external interrupt.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param interruptNum Interrupt number to attach to (platform-specific).
|
|
\param interruptCb Interrupt service routine to execute.
|
|
\param mode Rising/falling mode (platform-specific).
|
|
*/
|
|
virtual void attachInterrupt(uint32_t interruptNum, void (*interruptCb)(void), uint32_t mode) = 0;
|
|
|
|
/*!
|
|
\brief Method to detach function from an external interrupt.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param interruptNum Interrupt number to detach from (platform-specific).
|
|
*/
|
|
virtual void detachInterrupt(uint32_t interruptNum) = 0;
|
|
|
|
/*!
|
|
\brief Blocking wait function.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param ms Number of milliseconds to wait.
|
|
*/
|
|
virtual void delay(unsigned long ms) = 0;
|
|
|
|
/*!
|
|
\brief Blocking microsecond wait function.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param us Number of microseconds to wait.
|
|
*/
|
|
virtual void delayMicroseconds(unsigned long us) = 0;
|
|
|
|
/*!
|
|
\brief Get number of milliseconds since start.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\returns Number of milliseconds since start.
|
|
*/
|
|
virtual unsigned long millis() = 0;
|
|
|
|
/*!
|
|
\brief Get number of microseconds since start.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\returns Number of microseconds since start.
|
|
*/
|
|
virtual unsigned long micros() = 0;
|
|
|
|
/*!
|
|
\brief Measure the length of incoming digital pulse in microseconds.
|
|
Must be implemented by the platform-specific hardware abstraction!
|
|
\param pin Pin to measure on (platform-specific).
|
|
\param state Pin level to monitor (platform-specific).
|
|
\param timeout Timeout in microseconds.
|
|
\returns Pulse length in microseconds, or 0 if the pulse did not start before timeout.
|
|
*/
|
|
virtual long pulseIn(uint32_t pin, uint32_t state, unsigned long timeout) = 0;
|
|
|
|
/*!
|
|
\brief SPI initialization method.
|
|
*/
|
|
virtual void spiBegin() = 0;
|
|
|
|
/*!
|
|
\brief Method to start SPI transaction.
|
|
*/
|
|
virtual void spiBeginTransaction() = 0;
|
|
|
|
/*!
|
|
\brief Method to transfer buffer over SPI.
|
|
\param out Buffer to send.
|
|
\param len Number of data to send or receive.
|
|
\param in Buffer to save received data into.
|
|
*/
|
|
virtual void spiTransfer(uint8_t* out, size_t len, uint8_t* in) = 0;
|
|
|
|
/*!
|
|
\brief Method to end SPI transaction.
|
|
*/
|
|
virtual void spiEndTransaction() = 0;
|
|
|
|
/*!
|
|
\brief SPI termination method.
|
|
*/
|
|
virtual void spiEnd() = 0;
|
|
|
|
// virtual methods - these may or may not exists on a given platform
|
|
// they exist in this implementation, but do nothing
|
|
|
|
/*!
|
|
\brief Module initialization method.
|
|
This will be called by all radio modules at the beginning of startup.
|
|
Can be used to e.g., initialize SPI interface.
|
|
*/
|
|
virtual void init();
|
|
|
|
/*!
|
|
\brief Module termination method.
|
|
This will be called by all radio modules when the destructor is called.
|
|
Can be used to e.g., stop SPI interface.
|
|
*/
|
|
virtual void term();
|
|
|
|
/*!
|
|
\brief Method to produce a square-wave with 50% duty cycle ("tone") of a given frequency at some pin.
|
|
\param pin Pin to be used as the output.
|
|
\param frequency Frequency of the square wave.
|
|
\param duration Duration of the tone in ms. When set to 0, the tone will be infinite.
|
|
*/
|
|
virtual void tone(uint32_t pin, unsigned int frequency, unsigned long duration = 0);
|
|
|
|
/*!
|
|
\brief Method to stop producing a tone.
|
|
\param pin Pin which is currently producing the tone.
|
|
*/
|
|
virtual void noTone(uint32_t pin);
|
|
|
|
/*!
|
|
\brief Yield method, called from long loops in multi-threaded environment (to prevent blocking other threads).
|
|
*/
|
|
virtual void yield();
|
|
|
|
/*!
|
|
\brief Function to convert from pin number to interrupt number.
|
|
\param pin Pin to convert from.
|
|
\returns The interrupt number of a given pin.
|
|
*/
|
|
virtual uint32_t pinToInterrupt(uint32_t pin);
|
|
|
|
/*!
|
|
\brief Method to read from persistent storage (e.g. EEPROM).
|
|
\param addr Address to start reading at.
|
|
\param buff Buffer to read into.
|
|
\param len Number of bytes to read.
|
|
*/
|
|
virtual void readPersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
|
|
|
|
/*!
|
|
\brief Method to write to persistent storage (e.g. EEPROM).
|
|
\param addr Address to start writing to.
|
|
\param buff Buffer to write.
|
|
\param len Number of bytes to write.
|
|
*/
|
|
virtual void writePersistentStorage(uint32_t addr, uint8_t* buff, size_t len);
|
|
|
|
/*!
|
|
\brief Method to wipe the persistent storage by writing to 0.
|
|
Will write at most RADIOLIB_HAL_PERSISTENT_STORAGE_SIZE bytes.
|
|
*/
|
|
void wipePersistentStorage();
|
|
|
|
/*!
|
|
\brief Method to convert from persistent parameter ID to its physical address.
|
|
\param id Parameter ID.
|
|
\returns Parameter physical address.
|
|
*/
|
|
uint32_t getPersistentAddr(uint32_t id);
|
|
|
|
/*!
|
|
\brief Method to set arbitrary parameter to persistent storage.
|
|
This method DOES NOT perform any endianness conversion, so the value
|
|
will be stored in the system endian!
|
|
\param id Parameter ID to save at.
|
|
\param val Value to set.
|
|
\param offset An additional offset added to the address.
|
|
*/
|
|
template<typename T>
|
|
void setPersistentParameter(uint32_t id, T val, uint32_t offset = 0);
|
|
|
|
/*!
|
|
\brief Method to get arbitrary parameter from persistent storage.
|
|
This method DOES NOT perform any endianness conversion, so the value
|
|
will be retrieved in the system endian!
|
|
\param id Parameter ID to load from.
|
|
\returns The loaded value.
|
|
*/
|
|
template<typename T>
|
|
T getPersistentParameter(uint32_t id);
|
|
};
|
|
|
|
#endif
|