Helmut Tschemernjak / SX1276GenericLib

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_PingPong DISCO-L072CZ-LRWAN1_LoRa_USB_Rx ... more

Fork of SX1276Lib by Semtech

Arduino-mbed-APIs/arduino-esp32.cpp@103:59930a715bf8, 2017-11-20 (annotated)

Committer:
Helmut Tschemernjak
Date:
Mon Nov 20 12:42:09 2017 +0100
Revision:
103:59930a715bf8
Parent:
101:50377edb21c6
Child:
104:b5183e348f9d
Added all four timers, added more comments about rev0/1 ESP32's

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Helmut Tschemernjak 97:3d5d489206aa 1 /*
Helmut Tschemernjak 97:3d5d489206aa 2 * The file is Licensed under the Apache License, Version 2.0
Helmut Tschemernjak 97:3d5d489206aa 3 * (c) 2017 Helmut Tschemernjak
Helmut Tschemernjak 97:3d5d489206aa 4 * 30826 Garbsen (Hannover) Germany
Helmut Tschemernjak 97:3d5d489206aa 5 */
Helmut Tschemernjak 97:3d5d489206aa 6
Helmut Tschemernjak 97:3d5d489206aa 7 #ifdef ARDUINO
Helmut Tschemernjak 97:3d5d489206aa 8
Helmut Tschemernjak 97:3d5d489206aa 9 using namespace std;
Helmut Tschemernjak 97:3d5d489206aa 10
Helmut Tschemernjak 97:3d5d489206aa 11 #include "arduino-mbed.h"
Helmut Tschemernjak 97:3d5d489206aa 12 #include "arduino-util.h"
Helmut Tschemernjak 101:50377edb21c6 13 #include <time.h>
Helmut Tschemernjak 97:3d5d489206aa 14
Helmut Tschemernjak 97:3d5d489206aa 15
Helmut Tschemernjak 97:3d5d489206aa 16 #if defined(ARDUINO_ARCH_ESP32)
Helmut Tschemernjak 97:3d5d489206aa 17 /*
Helmut Tschemernjak 97:3d5d489206aa 18 * ARDUINO_ARCH_ESP32 ESP32 development board
Helmut Tschemernjak 97:3d5d489206aa 19 * Heltec ESP32 boards
Helmut Tschemernjak 97:3d5d489206aa 20 */
Helmut Tschemernjak 97:3d5d489206aa 21
Helmut Tschemernjak 97:3d5d489206aa 22 int
Helmut Tschemernjak 97:3d5d489206aa 23 CPUID(uint8_t *buf, int maxSize, uint32_t xorval)
Helmut Tschemernjak 97:3d5d489206aa 24 {
Helmut Tschemernjak 97:3d5d489206aa 25 uint64_t chipid = ESP.getEfuseMac();//The chip ID is essentially its MAC address(length: 6 bytes).
Helmut Tschemernjak 97:3d5d489206aa 26
Helmut Tschemernjak 97:3d5d489206aa 27
Helmut Tschemernjak 97:3d5d489206aa 28 if (maxSize >= sizeof(chipid)) {
Helmut Tschemernjak 97:3d5d489206aa 29 memset(buf, 0, maxSize);
Helmut Tschemernjak 97:3d5d489206aa 30 chipid = chipid ^ xorval;
Helmut Tschemernjak 97:3d5d489206aa 31 memcpy(&chipid, buf, sizeof(chipid));
Helmut Tschemernjak 97:3d5d489206aa 32 return sizeof(chipid) ;
Helmut Tschemernjak 97:3d5d489206aa 33 }
Helmut Tschemernjak 97:3d5d489206aa 34 return 0;
Helmut Tschemernjak 97:3d5d489206aa 35 }
Helmut Tschemernjak 97:3d5d489206aa 36
Helmut Tschemernjak 97:3d5d489206aa 37 /*
Helmut Tschemernjak 97:3d5d489206aa 38 * see esp32-hal-timer.h is automatically included from:
Helmut Tschemernjak 97:3d5d489206aa 39 * Arduino15/packages/arduino/hardware/espressif/esp32/cores/esp32
Helmut Tschemernjak 97:3d5d489206aa 40 */
Helmut Tschemernjak 97:3d5d489206aa 41 static void initTimer(int timerID);
Helmut Tschemernjak 97:3d5d489206aa 42 void IRAM_ATTR onTimer(void);
Helmut Tschemernjak 97:3d5d489206aa 43 /*
Helmut Tschemernjak 103:59930a715bf8 44 * The Atmel ESP32 has four 64-bit timer.
Helmut Tschemernjak 103:59930a715bf8 45 * At present the solution uses two timers, one for counting ticks,
Helmut Tschemernjak 103:59930a715bf8 46 * a second for setting alarms. This is required for the rev-0 ESP
Helmut Tschemernjak 103:59930a715bf8 47 *
Helmut Tschemernjak 103:59930a715bf8 48 * For the rev. 1 ESP a single timer will work for counting as well for
Helmut Tschemernjak 103:59930a715bf8 49 * setting the alarm via timerAlarmWrite(timer, timerRead(timer) + 1000000, false)
Helmut Tschemernjak 103:59930a715bf8 50 * once we support only ESP32-R1 the timer functions can be optimized to use only a
Helmut Tschemernjak 103:59930a715bf8 51 * single 64-bit timer.
Helmut Tschemernjak 97:3d5d489206aa 52 */
Helmut Tschemernjak 97:3d5d489206aa 53 struct TIMER_config {
Helmut Tschemernjak 97:3d5d489206aa 54 int timerID;
Helmut Tschemernjak 97:3d5d489206aa 55 hw_timer_t *timer;
Helmut Tschemernjak 97:3d5d489206aa 56 uint8_t nbits;
Helmut Tschemernjak 97:3d5d489206aa 57 } Timer_data[] {
Helmut Tschemernjak 97:3d5d489206aa 58 { 0, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 59 { 1, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 60 { 2, NULL, 32 },
Helmut Tschemernjak 103:59930a715bf8 61 { 3, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 62 { -1, NULL, 0 }
Helmut Tschemernjak 97:3d5d489206aa 63 };
Helmut Tschemernjak 97:3d5d489206aa 64
Helmut Tschemernjak 97:3d5d489206aa 65 /*
Helmut Tschemernjak 97:3d5d489206aa 66 * We preferably use ESP32 timers because it supports 64-bit counters
Helmut Tschemernjak 97:3d5d489206aa 67 */
Helmut Tschemernjak 97:3d5d489206aa 68 #define USE_TIMER_TIMEOUT 0 // 0, 1, 2 (see ESP32 docs)
Helmut Tschemernjak 97:3d5d489206aa 69 #define USE_TIMER_TICKER 1 // 0, 1, 2 (see ESP32 docs)
Helmut Tschemernjak 97:3d5d489206aa 70 #define MAX_TIMERS 3
Helmut Tschemernjak 101:50377edb21c6 71 #define TIMER_DIVIDER 80
Helmut Tschemernjak 101:50377edb21c6 72 #define TIMER_CLOCK 80
Helmut Tschemernjak 97:3d5d489206aa 73
Helmut Tschemernjak 97:3d5d489206aa 74 /*
Helmut Tschemernjak 97:3d5d489206aa 75 * Calculation of ticks see timerBegin divider
Helmut Tschemernjak 97:3d5d489206aa 76 */
Helmut Tschemernjak 97:3d5d489206aa 77 #define NS_PER_CLOCK_CPU 1000 // ns secs per clock
Helmut Tschemernjak 97:3d5d489206aa 78 #define NS_PER_CLOCK_RTC 1000 // ns secs per clock
Helmut Tschemernjak 97:3d5d489206aa 79 #define TIMER_INFINITE 0x7fffffffffffffff // max esp alarm timeout
Helmut Tschemernjak 97:3d5d489206aa 80 #define NS_PER_CLOCK NS_PER_CLOCK_RTC
Helmut Tschemernjak 97:3d5d489206aa 81
Helmut Tschemernjak 97:3d5d489206aa 82
Helmut Tschemernjak 97:3d5d489206aa 83 const char *GetTimerName(int timerID)
Helmut Tschemernjak 97:3d5d489206aa 84 {
Helmut Tschemernjak 97:3d5d489206aa 85 switch(timerID) {
Helmut Tschemernjak 97:3d5d489206aa 86 case USE_TIMER_TIMEOUT:
Helmut Tschemernjak 97:3d5d489206aa 87 return "TIMEOUT";
Helmut Tschemernjak 97:3d5d489206aa 88 break;
Helmut Tschemernjak 97:3d5d489206aa 89 case USE_TIMER_TICKER:
Helmut Tschemernjak 97:3d5d489206aa 90 return "TICKER";
Helmut Tschemernjak 97:3d5d489206aa 91 break;
Helmut Tschemernjak 97:3d5d489206aa 92 default:
Helmut Tschemernjak 97:3d5d489206aa 93 return "Uknown";
Helmut Tschemernjak 97:3d5d489206aa 94 }
Helmut Tschemernjak 97:3d5d489206aa 95 }
Helmut Tschemernjak 97:3d5d489206aa 96
Helmut Tschemernjak 97:3d5d489206aa 97 /* ----------------- TICKER TIMER CODE ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 98
Helmut Tschemernjak 97:3d5d489206aa 99 /*
Helmut Tschemernjak 97:3d5d489206aa 100 * The global ns_counter contains the time in ns from the last time
Helmut Tschemernjak 97:3d5d489206aa 101 * the counter has been wrapped. It cannot be used directly because the
Helmut Tschemernjak 97:3d5d489206aa 102 * current counter has to be added fore using it. Use instead
Helmut Tschemernjak 97:3d5d489206aa 103 * ns_getTicker(), us_ ns_getTicker(), ms_getTicker()
Helmut Tschemernjak 97:3d5d489206aa 104 */
Helmut Tschemernjak 97:3d5d489206aa 105
Helmut Tschemernjak 97:3d5d489206aa 106 static volatile bool initTickerDone = false;
Helmut Tschemernjak 97:3d5d489206aa 107
Helmut Tschemernjak 97:3d5d489206aa 108 uint64_t ns_getTicker(void)
Helmut Tschemernjak 97:3d5d489206aa 109 {
Helmut Tschemernjak 97:3d5d489206aa 110 int timerID = Timer_data[USE_TIMER_TICKER].timerID;
Helmut Tschemernjak 97:3d5d489206aa 111
Helmut Tschemernjak 97:3d5d489206aa 112 if (!initTickerDone) {
Helmut Tschemernjak 97:3d5d489206aa 113 initTimer(timerID);
Helmut Tschemernjak 97:3d5d489206aa 114 initTickerDone = true;
Helmut Tschemernjak 97:3d5d489206aa 115 }
Helmut Tschemernjak 97:3d5d489206aa 116
Helmut Tschemernjak 97:3d5d489206aa 117 hw_timer_t *timer = Timer_data[USE_TIMER_TICKER].timer;
Helmut Tschemernjak 97:3d5d489206aa 118 uint64_t ns = timerRead(timer);
Helmut Tschemernjak 97:3d5d489206aa 119 uint16_t div = timerGetDivider(timer);
Helmut Tschemernjak 97:3d5d489206aa 120 ns *= div; // get to the real clocks
Helmut Tschemernjak 101:50377edb21c6 121 ns *= 1000; // convert micros to NS.
Helmut Tschemernjak 101:50377edb21c6 122 ns /= TIMER_CLOCK; // 80 MHz clock, convert to micro seconds
Helmut Tschemernjak 97:3d5d489206aa 123
Helmut Tschemernjak 97:3d5d489206aa 124 return ns;
Helmut Tschemernjak 97:3d5d489206aa 125 }
Helmut Tschemernjak 97:3d5d489206aa 126
Helmut Tschemernjak 97:3d5d489206aa 127
Helmut Tschemernjak 97:3d5d489206aa 128 /* ----------------- SUPPORT CODE FOR TCC TIMERS----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 129
Helmut Tschemernjak 97:3d5d489206aa 130 static volatile bool initTimerDone = false;
Helmut Tschemernjak 97:3d5d489206aa 131
Helmut Tschemernjak 97:3d5d489206aa 132 static void initTimer(int timerID)
Helmut Tschemernjak 97:3d5d489206aa 133 {
Helmut Tschemernjak 97:3d5d489206aa 134 //dprintf("initTimer: %s", GetTimerName(timerID));
Helmut Tschemernjak 97:3d5d489206aa 135 struct TIMER_config *cp = &Timer_data[timerID];
Helmut Tschemernjak 97:3d5d489206aa 136 if (timerID > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 137 return;
Helmut Tschemernjak 97:3d5d489206aa 138
Helmut Tschemernjak 101:50377edb21c6 139 cp->timer = timerBegin(timerID, TIMER_DIVIDER, true);
Helmut Tschemernjak 97:3d5d489206aa 140 timerWrite(cp->timer, 0);
Helmut Tschemernjak 101:50377edb21c6 141 if (timerID == USE_TIMER_TICKER) {
Helmut Tschemernjak 101:50377edb21c6 142 time_t t = time(NULL);
Helmut Tschemernjak 101:50377edb21c6 143 if (t > 0) {
Helmut Tschemernjak 101:50377edb21c6 144 struct tm mytm;
Helmut Tschemernjak 101:50377edb21c6 145 uint64_t tstart;
Helmut Tschemernjak 101:50377edb21c6 146
Helmut Tschemernjak 101:50377edb21c6 147 localtime_r(&t, &mytm);
Helmut Tschemernjak 101:50377edb21c6 148 tstart = mytm.tm_sec + (mytm.tm_min * 60) + (mytm.tm_hour * 3600);
Helmut Tschemernjak 101:50377edb21c6 149 tstart *= 1000000;
Helmut Tschemernjak 101:50377edb21c6 150 tstart *= TIMER_CLOCK;
Helmut Tschemernjak 101:50377edb21c6 151 tstart /= TIMER_DIVIDER;
Helmut Tschemernjak 101:50377edb21c6 152 timerWrite(cp->timer, tstart);
Helmut Tschemernjak 101:50377edb21c6 153 }
Helmut Tschemernjak 97:3d5d489206aa 154 timerStart(cp->timer);
Helmut Tschemernjak 101:50377edb21c6 155 } else {
Helmut Tschemernjak 97:3d5d489206aa 156 timerAttachInterrupt(cp->timer, &onTimer, true);
Helmut Tschemernjak 97:3d5d489206aa 157 timerAlarmWrite(cp->timer, TIMER_INFINITE, true);
Helmut Tschemernjak 97:3d5d489206aa 158 timerAlarmEnable(cp->timer);
Helmut Tschemernjak 97:3d5d489206aa 159 timerStart(cp->timer);
Helmut Tschemernjak 97:3d5d489206aa 160 }
Helmut Tschemernjak 97:3d5d489206aa 161 /*
Helmut Tschemernjak 97:3d5d489206aa 162 * somehow the timer needs some time to initalize before being used.
Helmut Tschemernjak 97:3d5d489206aa 163 * otherwise it will not issue any alarms
Helmut Tschemernjak 97:3d5d489206aa 164 * This affects only ESP32 rev 0
Helmut Tschemernjak 97:3d5d489206aa 165 */
Helmut Tschemernjak 101:50377edb21c6 166 if (ESP.getChipRevision() == 0)
Helmut Tschemernjak 101:50377edb21c6 167 delay(20);
Helmut Tschemernjak 97:3d5d489206aa 168 }
Helmut Tschemernjak 97:3d5d489206aa 169
Helmut Tschemernjak 97:3d5d489206aa 170
Helmut Tschemernjak 97:3d5d489206aa 171 TIMER_REF *getTimeoutTimer(void)
Helmut Tschemernjak 97:3d5d489206aa 172 {
Helmut Tschemernjak 97:3d5d489206aa 173 struct TIMER_config *cp = &Timer_data[USE_TIMER_TIMEOUT];
Helmut Tschemernjak 97:3d5d489206aa 174
Helmut Tschemernjak 97:3d5d489206aa 175 return &cp->timerID;
Helmut Tschemernjak 97:3d5d489206aa 176 }
Helmut Tschemernjak 97:3d5d489206aa 177
Helmut Tschemernjak 97:3d5d489206aa 178
Helmut Tschemernjak 97:3d5d489206aa 179 void stopTimer(int *timerIDPtr)
Helmut Tschemernjak 97:3d5d489206aa 180 {
Helmut Tschemernjak 97:3d5d489206aa 181 struct TIMER_config *cp = &Timer_data[*timerIDPtr];
Helmut Tschemernjak 97:3d5d489206aa 182 if (*timerIDPtr > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 183 return;
Helmut Tschemernjak 97:3d5d489206aa 184
Helmut Tschemernjak 97:3d5d489206aa 185 if (cp->timer)
Helmut Tschemernjak 97:3d5d489206aa 186 timerAlarmWrite(cp->timer, TIMER_INFINITE, true);
Helmut Tschemernjak 97:3d5d489206aa 187 }
Helmut Tschemernjak 97:3d5d489206aa 188
Helmut Tschemernjak 97:3d5d489206aa 189
Helmut Tschemernjak 97:3d5d489206aa 190 /* ----------------- TIMEOUT TIMER CODE ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 191
Helmut Tschemernjak 97:3d5d489206aa 192 void startTimer(int *timerIDPtr, uint64_t delay_ns)
Helmut Tschemernjak 97:3d5d489206aa 193 {
Helmut Tschemernjak 97:3d5d489206aa 194 if (!initTimerDone) {
Helmut Tschemernjak 97:3d5d489206aa 195 initTimer(*timerIDPtr); // initial setup with stopped timer
Helmut Tschemernjak 97:3d5d489206aa 196 initTimerDone = true;
Helmut Tschemernjak 97:3d5d489206aa 197 }
Helmut Tschemernjak 97:3d5d489206aa 198
Helmut Tschemernjak 97:3d5d489206aa 199 struct TIMER_config *cp = &Timer_data[*timerIDPtr];
Helmut Tschemernjak 97:3d5d489206aa 200 if (*timerIDPtr > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 201 return;
Helmut Tschemernjak 97:3d5d489206aa 202 uint64_t usecs = delay_ns/1000;
Helmut Tschemernjak 97:3d5d489206aa 203 if (delay_ns == 1) // immediate timeout
Helmut Tschemernjak 97:3d5d489206aa 204 usecs = 1;
Helmut Tschemernjak 97:3d5d489206aa 205 timerAlarmWrite(cp->timer, usecs, true);
Helmut Tschemernjak 97:3d5d489206aa 206 // dprintf("startTimer: %s in %d us", GetTimerName(*timerIDPtr), usecs);
Helmut Tschemernjak 97:3d5d489206aa 207 }
Helmut Tschemernjak 97:3d5d489206aa 208
Helmut Tschemernjak 97:3d5d489206aa 209 /*
Helmut Tschemernjak 97:3d5d489206aa 210 * The onTimer is only called for every Timeout expired timer
Helmut Tschemernjak 97:3d5d489206aa 211 */
Helmut Tschemernjak 97:3d5d489206aa 212 void IRAM_ATTR onTimer(void) {
Helmut Tschemernjak 97:3d5d489206aa 213 //dprintf("onTimer int called");
Helmut Tschemernjak 97:3d5d489206aa 214 uint64_t nsecs = ns_getTicker();
Helmut Tschemernjak 97:3d5d489206aa 215
Helmut Tschemernjak 97:3d5d489206aa 216 for (int i = 0; i < MAX_TIMEOUTS-1; i++) {
Helmut Tschemernjak 97:3d5d489206aa 217 struct TimeoutVector *tvp = &TimeOuts[i];
Helmut Tschemernjak 97:3d5d489206aa 218 if (tvp->timer && nsecs >= tvp->timer->_timeout) {
Helmut Tschemernjak 97:3d5d489206aa 219 Timeout *saveTimer = tvp->timer;
Helmut Tschemernjak 97:3d5d489206aa 220 tvp->timer = NULL;
Helmut Tschemernjak 97:3d5d489206aa 221 Timeout::_irq_handler(saveTimer);
Helmut Tschemernjak 97:3d5d489206aa 222 }
Helmut Tschemernjak 97:3d5d489206aa 223 }
Helmut Tschemernjak 97:3d5d489206aa 224 /*
Helmut Tschemernjak 97:3d5d489206aa 225 * we need to restart the timer for remaining interrupts
Helmut Tschemernjak 97:3d5d489206aa 226 * Another reason is that we stopped this counter, in case there are
Helmut Tschemernjak 97:3d5d489206aa 227 * remaining counts, we need to re-schedule the counter.
Helmut Tschemernjak 97:3d5d489206aa 228 */
Helmut Tschemernjak 97:3d5d489206aa 229 Timeout::restart();
Helmut Tschemernjak 97:3d5d489206aa 230 }
Helmut Tschemernjak 97:3d5d489206aa 231
Helmut Tschemernjak 97:3d5d489206aa 232
Helmut Tschemernjak 97:3d5d489206aa 233 /* ----------------- ESP32 sleep() and deepsleep() code ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 234
Helmut Tschemernjak 97:3d5d489206aa 235 void sleep(void)
Helmut Tschemernjak 97:3d5d489206aa 236 {
Helmut Tschemernjak 97:3d5d489206aa 237 asm("waiti 0");
Helmut Tschemernjak 97:3d5d489206aa 238 }
Helmut Tschemernjak 97:3d5d489206aa 239
Helmut Tschemernjak 97:3d5d489206aa 240 /*
Helmut Tschemernjak 97:3d5d489206aa 241 * TODO
Helmut Tschemernjak 97:3d5d489206aa 242 * The ESP32 deepsleep can be enhanced to bring the ESP into low power mode.
Helmut Tschemernjak 97:3d5d489206aa 243 */
Helmut Tschemernjak 97:3d5d489206aa 244
Helmut Tschemernjak 97:3d5d489206aa 245 void deepsleep(void)
Helmut Tschemernjak 97:3d5d489206aa 246 {
Helmut Tschemernjak 101:50377edb21c6 247 // Light Sleep
Helmut Tschemernjak 97:3d5d489206aa 248 asm("waiti 0");
Helmut Tschemernjak 97:3d5d489206aa 249 }
Helmut Tschemernjak 97:3d5d489206aa 250
Helmut Tschemernjak 97:3d5d489206aa 251 #endif // ESp32 Timer, sleep, etc.
Helmut Tschemernjak 97:3d5d489206aa 252
Helmut Tschemernjak 97:3d5d489206aa 253 #endif // ARDUINO