/******************************************************************************* * Copyright (c) 2014-2015 IBM Corporation. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html * * Contributors: * IBM Zurich Research Lab - initial API, implementation and documentation *******************************************************************************/ //! \file #ifndef _oslmic_h_ #define _oslmic_h_ // Dependencies required for the LoRa MAC in C to run. // These settings can be adapted to the underlying system. // You should not, however, change the lmic.[hc] #include "config.h" #include #include #ifdef __cplusplus extern "C"{ #endif //================================================================================ //================================================================================ // Target platform as C library typedef uint8_t bit_t; typedef uint8_t u1_t; typedef int8_t s1_t; typedef uint16_t u2_t; typedef int16_t s2_t; typedef uint32_t u4_t; typedef int32_t s4_t; typedef unsigned int uint; typedef const char* str_t; #include #include "hal.h" #define EV(a,b,c) /**/ #define DO_DEVDB(field1,field2) /**/ #if !defined(CFG_noassert) #define ASSERT(cond) if(!(cond)) hal_failed(__FILE__, __LINE__) #else #define ASSERT(cond) /**/ #endif #define os_clearMem(a,b) memset(a,0,b) #define os_copyMem(a,b,c) memcpy(a,b,c) typedef struct osjob_t osjob_t; typedef struct band_t band_t; typedef struct chnldef_t chnldef_t; typedef struct rxsched_t rxsched_t; typedef struct bcninfo_t bcninfo_t; typedef const u1_t* xref2cu1_t; typedef u1_t* xref2u1_t; #define TYPEDEF_xref2rps_t typedef rps_t* xref2rps_t #define TYPEDEF_xref2rxsched_t typedef rxsched_t* xref2rxsched_t #define TYPEDEF_xref2chnldef_t typedef chnldef_t* xref2chnldef_t #define TYPEDEF_xref2band_t typedef band_t* xref2band_t #define TYPEDEF_xref2osjob_t typedef osjob_t* xref2osjob_t #define SIZEOFEXPR(x) sizeof(x) #define ON_LMIC_EVENT(ev) onEvent(ev) #define DECL_ON_LMIC_EVENT void onEvent(ev_t e) extern u4_t AESAUX[]; extern u4_t AESKEY[]; #define AESkey ((u1_t*)AESKEY) #define AESaux ((u1_t*)AESAUX) #define FUNC_ADDR(func) (&(func)) u1_t radio_rand1 (void); #define os_getRndU1() radio_rand1() #define DEFINE_LMIC struct lmic_t LMIC #define DECLARE_LMIC extern struct lmic_t LMIC void radio_init (void); void radio_irq_handler (u1_t dio); void os_init (void); void os_runloop (void); void os_runloop_once (void); //================================================================================ #ifndef RX_RAMPUP #define RX_RAMPUP (us2osticks(2000)) #endif #ifndef TX_RAMPUP #define TX_RAMPUP (us2osticks(2000)) #endif #ifndef OSTICKS_PER_SEC #define OSTICKS_PER_SEC 32768 #elif OSTICKS_PER_SEC < 10000 || OSTICKS_PER_SEC > 64516 #error Illegal OSTICKS_PER_SEC - must be in range [10000:64516]. One tick must be 15.5us .. 100us long. #endif typedef s4_t ostime_t; #if !HAS_ostick_conv #define us2osticks(us) ((ostime_t)( ((int64_t)(us) * OSTICKS_PER_SEC) / 1000000)) #define ms2osticks(ms) ((ostime_t)( ((int64_t)(ms) * OSTICKS_PER_SEC) / 1000)) #define sec2osticks(sec) ((ostime_t)( (int64_t)(sec) * OSTICKS_PER_SEC)) #define osticks2ms(os) ((s4_t)(((os)*(int64_t)1000 ) / OSTICKS_PER_SEC)) #define osticks2us(os) ((s4_t)(((os)*(int64_t)1000000 ) / OSTICKS_PER_SEC)) // Special versions #define us2osticksCeil(us) ((ostime_t)( ((int64_t)(us) * OSTICKS_PER_SEC + 999999) / 1000000)) #define us2osticksRound(us) ((ostime_t)( ((int64_t)(us) * OSTICKS_PER_SEC + 500000) / 1000000)) #define ms2osticksCeil(ms) ((ostime_t)( ((int64_t)(ms) * OSTICKS_PER_SEC + 999) / 1000)) #define ms2osticksRound(ms) ((ostime_t)( ((int64_t)(ms) * OSTICKS_PER_SEC + 500) / 1000)) #endif struct osjob_t; // fwd decl. typedef void (*osjobcb_t) (struct osjob_t*); struct osjob_t { struct osjob_t* next; ostime_t deadline; osjobcb_t func; }; TYPEDEF_xref2osjob_t; #ifndef HAS_os_calls #ifndef os_getDevKey void os_getDevKey (xref2u1_t buf); #endif #ifndef os_getArtEui void os_getArtEui (xref2u1_t buf); #endif #ifndef os_getDevEui void os_getDevEui (xref2u1_t buf); #endif #ifndef os_setCallback void os_setCallback (xref2osjob_t job, osjobcb_t cb); #endif #ifndef os_setTimedCallback void os_setTimedCallback (xref2osjob_t job, ostime_t time, osjobcb_t cb); #endif #ifndef os_clearCallback void os_clearCallback (xref2osjob_t job); #endif #ifndef os_getTime ostime_t os_getTime (void); #endif #ifndef os_getTimeSecs uint os_getTimeSecs (void); #endif #ifndef os_radio void os_radio (u1_t mode); #endif #ifndef os_getBattLevel u1_t os_getBattLevel (void); #endif #ifndef os_rlsbf4 //! Read 32-bit quantity from given pointer in little endian byte order. u4_t os_rlsbf4 (xref2cu1_t buf); #endif #ifndef os_wlsbf4 //! Write 32-bit quntity into buffer in little endian byte order. void os_wlsbf4 (xref2u1_t buf, u4_t value); #endif #ifndef os_rmsbf4 //! Read 32-bit quantity from given pointer in big endian byte order. u4_t os_rmsbf4 (xref2cu1_t buf); #endif #ifndef os_wmsbf4 //! Write 32-bit quntity into buffer in big endian byte order. void os_wmsbf4 (xref2u1_t buf, u4_t value); #endif #ifndef os_rlsbf2 //! Read 16-bit quantity from given pointer in little endian byte order. u2_t os_rlsbf2 (xref2cu1_t buf); #endif #ifndef os_wlsbf2 //! Write 16-bit quntity into buffer in little endian byte order. void os_wlsbf2 (xref2u1_t buf, u2_t value); #endif //! Get random number (default impl for u2_t). #ifndef os_getRndU2 #define os_getRndU2() ((u2_t)((os_getRndU1()<<8)|os_getRndU1())) #endif #ifndef os_crc16 u2_t os_crc16 (xref2u1_t d, uint len); #endif #endif // !HAS_os_calls // ====================================================================== // Table support // These macros for defining a table of constants and retrieving values // from it makes it easier for other platforms (like AVR) to optimize // table accesses. // Use CONST_TABLE() whenever declaring or defining a table, and // TABLE_GET_xx whenever accessing its values. The actual name of the // declared variable will be modified to prevent accidental direct // access. The accessor macros forward to an inline function to allow // proper type checking of the array element type. // Helper to add a prefix to the table name #define RESOLVE_TABLE(table) constant_table_ ## table // Accessors for table elements #define TABLE_GET_U1(table, index) table_get_u1(RESOLVE_TABLE(table), index) #define TABLE_GET_S1(table, index) table_get_s1(RESOLVE_TABLE(table), index) #define TABLE_GET_U2(table, index) table_get_u2(RESOLVE_TABLE(table), index) #define TABLE_GET_S2(table, index) table_get_s2(RESOLVE_TABLE(table), index) #define TABLE_GET_U4(table, index) table_get_u4(RESOLVE_TABLE(table), index) #define TABLE_GET_S4(table, index) table_get_s4(RESOLVE_TABLE(table), index) #define TABLE_GET_OSTIME(table, index) table_get_ostime(RESOLVE_TABLE(table), index) #define TABLE_GET_U1_TWODIM(table, index1, index2) table_get_u1(RESOLVE_TABLE(table)[index1], index2) #if defined(__AVR__) #include // Macro to define the getter functions. This loads data from // progmem using pgm_read_xx, or accesses memory directly when the // index is a constant so gcc can optimize it away; #define TABLE_GETTER(postfix, type, pgm_type) \ inline type table_get ## postfix(const type *table, size_t index) { \ if (__builtin_constant_p(table[index])) \ return table[index]; \ return pgm_read_ ## pgm_type(&table[index]); \ } TABLE_GETTER(_u1, u1_t, byte); TABLE_GETTER(_s1, s1_t, byte); TABLE_GETTER(_u2, u2_t, word); TABLE_GETTER(_s2, s2_t, word); TABLE_GETTER(_u4, u4_t, dword); TABLE_GETTER(_s4, s4_t, dword); // This assumes ostime_t is 4 bytes, so error out if it is not typedef int check_sizeof_ostime_t[(sizeof(ostime_t) == 4) ? 0 : -1]; TABLE_GETTER(_ostime, ostime_t, dword); // For AVR, store constants in PROGMEM, saving on RAM usage #define CONST_TABLE(type, name) const type PROGMEM RESOLVE_TABLE(name) #define lmic_printf(fmt, ...) printf_P(PSTR(fmt), ## __VA_ARGS__) #else inline u1_t table_get_u1(const u1_t *table, size_t index) { return table[index]; } inline s1_t table_get_s1(const s1_t *table, size_t index) { return table[index]; } inline u2_t table_get_u2(const u2_t *table, size_t index) { return table[index]; } inline s2_t table_get_s2(const s2_t *table, size_t index) { return table[index]; } inline u4_t table_get_u4(const u4_t *table, size_t index) { return table[index]; } inline s4_t table_get_s4(const s4_t *table, size_t index) { return table[index]; } inline ostime_t table_get_ostime(const ostime_t *table, size_t index) { return table[index]; } // Declare a table #define CONST_TABLE(type, name) const type RESOLVE_TABLE(name) #define lmic_printf printf #endif // ====================================================================== // AES support // !!Keep in sync with lorabase.hpp!! #ifndef AES_ENC // if AES_ENC is defined as macro all other values must be too #define AES_ENC 0x00 #define AES_DEC 0x01 #define AES_MIC 0x02 #define AES_CTR 0x04 #define AES_MICNOAUX 0x08 #endif #ifndef AESkey // if AESkey is defined as macro all other values must be too extern xref2u1_t AESkey; extern xref2u1_t AESaux; #endif #ifndef os_aes u4_t os_aes (u1_t mode, xref2u1_t buf, u2_t len); #endif #ifdef __cplusplus } // extern "C" #endif #endif // _oslmic_h_