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@97:3d5d489206aa, 2017-11-18 (annotated)

Committer:
Helmut Tschemernjak
Date:
Sat Nov 18 13:54:15 2017 +0100
Revision:
97:3d5d489206aa
Child:
101:50377edb21c6
Change timeout functions to use a generic TIMER_REF instead of a D21 TCC pointer

Added support for ESP32 SPI, Serial

Added suport for ESP32 64-bit timer

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 97:3d5d489206aa 13
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 97:3d5d489206aa 44 * The Atmel ESP32 has three 64-bit timer.
Helmut Tschemernjak 97:3d5d489206aa 45 */
Helmut Tschemernjak 97:3d5d489206aa 46 struct TIMER_config {
Helmut Tschemernjak 97:3d5d489206aa 47 int timerID;
Helmut Tschemernjak 97:3d5d489206aa 48 hw_timer_t *timer;
Helmut Tschemernjak 97:3d5d489206aa 49 uint8_t nbits;
Helmut Tschemernjak 97:3d5d489206aa 50 } Timer_data[] {
Helmut Tschemernjak 97:3d5d489206aa 51 { 0, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 52 { 1, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 53 { 2, NULL, 32 },
Helmut Tschemernjak 97:3d5d489206aa 54 { -1, NULL, 0 }
Helmut Tschemernjak 97:3d5d489206aa 55 };
Helmut Tschemernjak 97:3d5d489206aa 56
Helmut Tschemernjak 97:3d5d489206aa 57 /*
Helmut Tschemernjak 97:3d5d489206aa 58 * We preferably use ESP32 timers because it supports 64-bit counters
Helmut Tschemernjak 97:3d5d489206aa 59 */
Helmut Tschemernjak 97:3d5d489206aa 60 #define USE_TIMER_TIMEOUT 0 // 0, 1, 2 (see ESP32 docs)
Helmut Tschemernjak 97:3d5d489206aa 61 #define USE_TIMER_TICKER 1 // 0, 1, 2 (see ESP32 docs)
Helmut Tschemernjak 97:3d5d489206aa 62 #define MAX_TIMERS 3
Helmut Tschemernjak 97:3d5d489206aa 63
Helmut Tschemernjak 97:3d5d489206aa 64 /*
Helmut Tschemernjak 97:3d5d489206aa 65 * Calculation of ticks see timerBegin divider
Helmut Tschemernjak 97:3d5d489206aa 66 */
Helmut Tschemernjak 97:3d5d489206aa 67 #define NS_PER_CLOCK_CPU 1000 // ns secs per clock
Helmut Tschemernjak 97:3d5d489206aa 68 #define NS_PER_CLOCK_RTC 1000 // ns secs per clock
Helmut Tschemernjak 97:3d5d489206aa 69 #define TIMER_INFINITE 0x7fffffffffffffff // max esp alarm timeout
Helmut Tschemernjak 97:3d5d489206aa 70 #define NS_PER_CLOCK NS_PER_CLOCK_RTC
Helmut Tschemernjak 97:3d5d489206aa 71
Helmut Tschemernjak 97:3d5d489206aa 72
Helmut Tschemernjak 97:3d5d489206aa 73 const char *GetTimerName(int timerID)
Helmut Tschemernjak 97:3d5d489206aa 74 {
Helmut Tschemernjak 97:3d5d489206aa 75 switch(timerID) {
Helmut Tschemernjak 97:3d5d489206aa 76 case USE_TIMER_TIMEOUT:
Helmut Tschemernjak 97:3d5d489206aa 77 return "TIMEOUT";
Helmut Tschemernjak 97:3d5d489206aa 78 break;
Helmut Tschemernjak 97:3d5d489206aa 79 case USE_TIMER_TICKER:
Helmut Tschemernjak 97:3d5d489206aa 80 return "TICKER";
Helmut Tschemernjak 97:3d5d489206aa 81 break;
Helmut Tschemernjak 97:3d5d489206aa 82 default:
Helmut Tschemernjak 97:3d5d489206aa 83 return "Uknown";
Helmut Tschemernjak 97:3d5d489206aa 84 }
Helmut Tschemernjak 97:3d5d489206aa 85 }
Helmut Tschemernjak 97:3d5d489206aa 86
Helmut Tschemernjak 97:3d5d489206aa 87 /* ----------------- TICKER TIMER CODE ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 88
Helmut Tschemernjak 97:3d5d489206aa 89 /*
Helmut Tschemernjak 97:3d5d489206aa 90 * The global ns_counter contains the time in ns from the last time
Helmut Tschemernjak 97:3d5d489206aa 91 * the counter has been wrapped. It cannot be used directly because the
Helmut Tschemernjak 97:3d5d489206aa 92 * current counter has to be added fore using it. Use instead
Helmut Tschemernjak 97:3d5d489206aa 93 * ns_getTicker(), us_ ns_getTicker(), ms_getTicker()
Helmut Tschemernjak 97:3d5d489206aa 94 */
Helmut Tschemernjak 97:3d5d489206aa 95
Helmut Tschemernjak 97:3d5d489206aa 96 static volatile bool initTickerDone = false;
Helmut Tschemernjak 97:3d5d489206aa 97
Helmut Tschemernjak 97:3d5d489206aa 98 uint64_t ns_getTicker(void)
Helmut Tschemernjak 97:3d5d489206aa 99 {
Helmut Tschemernjak 97:3d5d489206aa 100 int timerID = Timer_data[USE_TIMER_TICKER].timerID;
Helmut Tschemernjak 97:3d5d489206aa 101
Helmut Tschemernjak 97:3d5d489206aa 102 if (!initTickerDone) {
Helmut Tschemernjak 97:3d5d489206aa 103 initTimer(timerID);
Helmut Tschemernjak 97:3d5d489206aa 104 initTickerDone = true;
Helmut Tschemernjak 97:3d5d489206aa 105 dprintf("ESP32 Revision: %d (%d MHz)\r\n", ESP.getChipRevision(), ESP.getCpuFreqMHz());
Helmut Tschemernjak 97:3d5d489206aa 106 }
Helmut Tschemernjak 97:3d5d489206aa 107
Helmut Tschemernjak 97:3d5d489206aa 108 hw_timer_t *timer = Timer_data[USE_TIMER_TICKER].timer;
Helmut Tschemernjak 97:3d5d489206aa 109 uint64_t ns = timerRead(timer);
Helmut Tschemernjak 97:3d5d489206aa 110 uint16_t div = timerGetDivider(timer);
Helmut Tschemernjak 97:3d5d489206aa 111 ns *= div; // get to the real clocks
Helmut Tschemernjak 97:3d5d489206aa 112 ns /= 8; // 80 MHz , divide by 8 to keep more NS
Helmut Tschemernjak 97:3d5d489206aa 113 ns *= 100; // us to ns equals 1000, however we divided only by 8 remaing are 1000
Helmut Tschemernjak 97:3d5d489206aa 114
Helmut Tschemernjak 97:3d5d489206aa 115 return ns;
Helmut Tschemernjak 97:3d5d489206aa 116 }
Helmut Tschemernjak 97:3d5d489206aa 117
Helmut Tschemernjak 97:3d5d489206aa 118
Helmut Tschemernjak 97:3d5d489206aa 119 /* ----------------- SUPPORT CODE FOR TCC TIMERS----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 120
Helmut Tschemernjak 97:3d5d489206aa 121 static volatile bool initTimerDone = false;
Helmut Tschemernjak 97:3d5d489206aa 122
Helmut Tschemernjak 97:3d5d489206aa 123 static void initTimer(int timerID)
Helmut Tschemernjak 97:3d5d489206aa 124 {
Helmut Tschemernjak 97:3d5d489206aa 125 //dprintf("initTimer: %s", GetTimerName(timerID));
Helmut Tschemernjak 97:3d5d489206aa 126 struct TIMER_config *cp = &Timer_data[timerID];
Helmut Tschemernjak 97:3d5d489206aa 127 if (timerID > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 128 return;
Helmut Tschemernjak 97:3d5d489206aa 129
Helmut Tschemernjak 97:3d5d489206aa 130 cp->timer = timerBegin(timerID, 80, true);
Helmut Tschemernjak 97:3d5d489206aa 131 timerWrite(cp->timer, 0);
Helmut Tschemernjak 97:3d5d489206aa 132 if (timerID == USE_TIMER_TICKER)
Helmut Tschemernjak 97:3d5d489206aa 133 timerStart(cp->timer);
Helmut Tschemernjak 97:3d5d489206aa 134 else {
Helmut Tschemernjak 97:3d5d489206aa 135 timerAttachInterrupt(cp->timer, &onTimer, true);
Helmut Tschemernjak 97:3d5d489206aa 136 timerAlarmWrite(cp->timer, TIMER_INFINITE, true);
Helmut Tschemernjak 97:3d5d489206aa 137 timerAlarmEnable(cp->timer);
Helmut Tschemernjak 97:3d5d489206aa 138 timerStart(cp->timer);
Helmut Tschemernjak 97:3d5d489206aa 139 }
Helmut Tschemernjak 97:3d5d489206aa 140 /*
Helmut Tschemernjak 97:3d5d489206aa 141 * somehow the timer needs some time to initalize before being used.
Helmut Tschemernjak 97:3d5d489206aa 142 * otherwise it will not issue any alarms
Helmut Tschemernjak 97:3d5d489206aa 143 * This affects only ESP32 rev 0
Helmut Tschemernjak 97:3d5d489206aa 144 */
Helmut Tschemernjak 97:3d5d489206aa 145 delay(20);
Helmut Tschemernjak 97:3d5d489206aa 146 }
Helmut Tschemernjak 97:3d5d489206aa 147
Helmut Tschemernjak 97:3d5d489206aa 148
Helmut Tschemernjak 97:3d5d489206aa 149 TIMER_REF *getTimeoutTimer(void)
Helmut Tschemernjak 97:3d5d489206aa 150 {
Helmut Tschemernjak 97:3d5d489206aa 151 struct TIMER_config *cp = &Timer_data[USE_TIMER_TIMEOUT];
Helmut Tschemernjak 97:3d5d489206aa 152
Helmut Tschemernjak 97:3d5d489206aa 153 return &cp->timerID;
Helmut Tschemernjak 97:3d5d489206aa 154 }
Helmut Tschemernjak 97:3d5d489206aa 155
Helmut Tschemernjak 97:3d5d489206aa 156
Helmut Tschemernjak 97:3d5d489206aa 157 void stopTimer(int *timerIDPtr)
Helmut Tschemernjak 97:3d5d489206aa 158 {
Helmut Tschemernjak 97:3d5d489206aa 159 struct TIMER_config *cp = &Timer_data[*timerIDPtr];
Helmut Tschemernjak 97:3d5d489206aa 160 if (*timerIDPtr > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 161 return;
Helmut Tschemernjak 97:3d5d489206aa 162
Helmut Tschemernjak 97:3d5d489206aa 163 if (cp->timer)
Helmut Tschemernjak 97:3d5d489206aa 164 timerAlarmWrite(cp->timer, TIMER_INFINITE, true);
Helmut Tschemernjak 97:3d5d489206aa 165 }
Helmut Tschemernjak 97:3d5d489206aa 166
Helmut Tschemernjak 97:3d5d489206aa 167
Helmut Tschemernjak 97:3d5d489206aa 168 /* ----------------- TIMEOUT TIMER CODE ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 169
Helmut Tschemernjak 97:3d5d489206aa 170 void startTimer(int *timerIDPtr, uint64_t delay_ns)
Helmut Tschemernjak 97:3d5d489206aa 171 {
Helmut Tschemernjak 97:3d5d489206aa 172 if (!initTimerDone) {
Helmut Tschemernjak 97:3d5d489206aa 173 initTimer(*timerIDPtr); // initial setup with stopped timer
Helmut Tschemernjak 97:3d5d489206aa 174 initTimerDone = true;
Helmut Tschemernjak 97:3d5d489206aa 175 }
Helmut Tschemernjak 97:3d5d489206aa 176
Helmut Tschemernjak 97:3d5d489206aa 177 struct TIMER_config *cp = &Timer_data[*timerIDPtr];
Helmut Tschemernjak 97:3d5d489206aa 178 if (*timerIDPtr > MAX_TIMERS-1)
Helmut Tschemernjak 97:3d5d489206aa 179 return;
Helmut Tschemernjak 97:3d5d489206aa 180 uint64_t usecs = delay_ns/1000;
Helmut Tschemernjak 97:3d5d489206aa 181 if (delay_ns == 1) // immediate timeout
Helmut Tschemernjak 97:3d5d489206aa 182 usecs = 1;
Helmut Tschemernjak 97:3d5d489206aa 183 timerAlarmWrite(cp->timer, usecs, true);
Helmut Tschemernjak 97:3d5d489206aa 184 // dprintf("startTimer: %s in %d us", GetTimerName(*timerIDPtr), usecs);
Helmut Tschemernjak 97:3d5d489206aa 185 }
Helmut Tschemernjak 97:3d5d489206aa 186
Helmut Tschemernjak 97:3d5d489206aa 187 /*
Helmut Tschemernjak 97:3d5d489206aa 188 * The onTimer is only called for every Timeout expired timer
Helmut Tschemernjak 97:3d5d489206aa 189 */
Helmut Tschemernjak 97:3d5d489206aa 190 void IRAM_ATTR onTimer(void) {
Helmut Tschemernjak 97:3d5d489206aa 191 //dprintf("onTimer int called");
Helmut Tschemernjak 97:3d5d489206aa 192 uint64_t nsecs = ns_getTicker();
Helmut Tschemernjak 97:3d5d489206aa 193
Helmut Tschemernjak 97:3d5d489206aa 194 for (int i = 0; i < MAX_TIMEOUTS-1; i++) {
Helmut Tschemernjak 97:3d5d489206aa 195 struct TimeoutVector *tvp = &TimeOuts[i];
Helmut Tschemernjak 97:3d5d489206aa 196 if (tvp->timer && nsecs >= tvp->timer->_timeout) {
Helmut Tschemernjak 97:3d5d489206aa 197 Timeout *saveTimer = tvp->timer;
Helmut Tschemernjak 97:3d5d489206aa 198 tvp->timer = NULL;
Helmut Tschemernjak 97:3d5d489206aa 199 Timeout::_irq_handler(saveTimer);
Helmut Tschemernjak 97:3d5d489206aa 200 }
Helmut Tschemernjak 97:3d5d489206aa 201 }
Helmut Tschemernjak 97:3d5d489206aa 202 /*
Helmut Tschemernjak 97:3d5d489206aa 203 * we need to restart the timer for remaining interrupts
Helmut Tschemernjak 97:3d5d489206aa 204 * Another reason is that we stopped this counter, in case there are
Helmut Tschemernjak 97:3d5d489206aa 205 * remaining counts, we need to re-schedule the counter.
Helmut Tschemernjak 97:3d5d489206aa 206 */
Helmut Tschemernjak 97:3d5d489206aa 207 Timeout::restart();
Helmut Tschemernjak 97:3d5d489206aa 208 }
Helmut Tschemernjak 97:3d5d489206aa 209
Helmut Tschemernjak 97:3d5d489206aa 210
Helmut Tschemernjak 97:3d5d489206aa 211 /* ----------------- ESP32 sleep() and deepsleep() code ----------------------*/
Helmut Tschemernjak 97:3d5d489206aa 212
Helmut Tschemernjak 97:3d5d489206aa 213 void sleep(void)
Helmut Tschemernjak 97:3d5d489206aa 214 {
Helmut Tschemernjak 97:3d5d489206aa 215 asm("waiti 0");
Helmut Tschemernjak 97:3d5d489206aa 216 }
Helmut Tschemernjak 97:3d5d489206aa 217
Helmut Tschemernjak 97:3d5d489206aa 218 /*
Helmut Tschemernjak 97:3d5d489206aa 219 * TODO
Helmut Tschemernjak 97:3d5d489206aa 220 * The ESP32 deepsleep can be enhanced to bring the ESP into low power mode.
Helmut Tschemernjak 97:3d5d489206aa 221 */
Helmut Tschemernjak 97:3d5d489206aa 222
Helmut Tschemernjak 97:3d5d489206aa 223 void deepsleep(void)
Helmut Tschemernjak 97:3d5d489206aa 224 {
Helmut Tschemernjak 97:3d5d489206aa 225 asm("waiti 0");
Helmut Tschemernjak 97:3d5d489206aa 226 }
Helmut Tschemernjak 97:3d5d489206aa 227
Helmut Tschemernjak 97:3d5d489206aa 228 #endif // ESp32 Timer, sleep, etc.
Helmut Tschemernjak 97:3d5d489206aa 229
Helmut Tschemernjak 97:3d5d489206aa 230 #endif // ARDUINO