Fix spelling warnings

esp8266 · earlephilhower · May 23, 2021 · May 21, 2021 · May 21, 2021 · May 21, 2021
commit c9849fcfef9d6c400204b2664fe2f67b9155f736
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -285,5 +285,5 @@ jobs:
     - name: Run codespell
       uses: codespell-project/actions-codespell@master
       with:
-        skip: ./libraries/ESP8266SdFat,./libraries/LittleFS/lib,./tools/pyserial
-        ignore_words_list: ESP8266,esp8266,esp
+        skip: ./libraries/ESP8266SdFat,./libraries/LittleFS/lib,./tools/pyserial,./tools/sdk,./tools/esptool,./libraries/SoftwareSerial
+        ignore_words_list: ESP8266,esp8266,esp,dout,DOUT
diff --git a/cores/esp8266/CallBackList.h b/cores/esp8266/CallBackList.h
@@ -1,9 +1,8 @@
 #ifndef __CALLBACKLIST_H__
 #define __CALLBACKLIST_H__
 
-
 /*
- CallBackList, An implemention for handling callback execution
+ CallBackList, An implementation for handling callback execution
 
  Copyright (c) 2019 Herman Reintke. All rights reserved.
  This file is part of the esp8266 core for Arduino environment.

diff --git a/cores/esp8266/Esp-frag.cpp b/cores/esp8266/Esp-frag.cpp
@@ -25,7 +25,7 @@
 
 void EspClass::getHeapStats(uint32_t* hfree, uint16_t* hmax, uint8_t* hfrag)
 {
-    // L2 / Euclidian norm of free block sizes.
+    // L2 / Euclidean norm of free block sizes.
     // Having getFreeHeap()=sum(hole-size), fragmentation is given by
     // 100 * (1 - sqrt(sum(hole-size²)) / sum(hole-size))
 

diff --git a/cores/esp8266/Esp.h b/cores/esp8266/Esp.h
@@ -26,7 +26,7 @@
 #include "spi_vendors.h"
 
 /**
- * AVR macros for WDT managment
+ * AVR macros for WDT management
  */
 typedef enum {
     WDTO_0MS    = 0,   //!< WDTO_0MS
@@ -264,7 +264,7 @@ class EspClass {
         bool flashReplaceBlock(uint32_t address, const uint8_t *value, uint32_t byteCount);
         /**
          * @brief Write up to @a size bytes from @a data to flash at @a address
-         * This function takes case of unaligned memory acces by copying @a data to a temporary buffer,
+         * This function takes case of unaligned memory access by copying @a data to a temporary buffer,
          * it also takes care of page boundary crossing see @a flashWritePageBreak as to why it's done.
          * Less than @a size bytes may be written, due to 4 byte alignment requirement of spi_flash_write
          * @param address address on flash where write should start

diff --git a/cores/esp8266/FSnoop.cpp b/cores/esp8266/FSnoop.cpp
@@ -15,7 +15,7 @@ void close_all_fs(void)
 }
 
 // default weak definitions
-// they are overriden in their respective real implementation
+// they are overridden in their respective real implementation
 // hint: https://github.com/esp8266/Arduino/pull/6699#issuecomment-549085382
 
 void littlefs_request_end(void) __attribute__((weak));

diff --git a/cores/esp8266/HardwareSerial.h b/cores/esp8266/HardwareSerial.h
@@ -132,7 +132,7 @@ class HardwareSerial: public Stream
 
     int peek(void) override
     {
-        // return -1 when data is unvailable (arduino api)
+        // return -1 when data is unavailable (arduino api)
         return uart_peek_char(_uart);
     }
 
@@ -162,7 +162,7 @@ class HardwareSerial: public Stream
 
     int read(void) override
     {
-        // return -1 when data is unvailable (arduino api)
+        // return -1 when data is unavailable (arduino api)
         return uart_read_char(_uart);
     }
     // ::read(buffer, size): same as readBytes without timeout

diff --git a/cores/esp8266/LwipDhcpServer-NonOS.cpp b/cores/esp8266/LwipDhcpServer-NonOS.cpp
@@ -51,7 +51,7 @@ extern "C"
         //                  trying to change legacy behavor
         // `fw_has_started_softap_dhcps` will be read in DhcpServer::DhcpServer
         // which is called when c++ ctors are initialized, specifically
-        // dhcpSoftAP intialized with AP interface number above.
+        // dhcpSoftAP initialized with AP interface number above.
         fw_has_started_softap_dhcps = 1;
 #endif
     }

diff --git a/cores/esp8266/Print.h b/cores/esp8266/Print.h
@@ -76,7 +76,7 @@ class Print {
         inline size_t write(int8_t c) { return write((uint8_t) c); }
 
         // default to zero, meaning "a single write may block"
-        // should be overriden by subclasses with buffering
+        // should be overridden by subclasses with buffering
         virtual int availableForWrite() { return 0; }
 
         size_t printf(const char * format, ...)  __attribute__ ((format (printf, 2, 3)));

diff --git a/cores/esp8266/Stream.cpp b/cores/esp8266/Stream.cpp
@@ -148,7 +148,7 @@ long Stream::parseInt(char skipChar) {
 
     do {
         if(c == skipChar)
-            ; // ignore this charactor
+            ; // ignore this character
         else if(c == '-')
             isNegative = true;
         else if(c >= '0' && c <= '9')        // is c a digit?

diff --git a/cores/esp8266/StreamString.h b/cores/esp8266/StreamString.h
@@ -230,7 +230,7 @@ class StreamString: public String, public S2Stream
     StreamString(StreamString&& bro): String(bro), S2Stream(this) { }
     StreamString(const StreamString& bro): String(bro), S2Stream(this) { }
 
-    // duplicate String contructors and operator=:
+    // duplicate String constructors and operator=:
 
     StreamString(const char* text = nullptr): String(text), S2Stream(this) { }
     StreamString(const String& string): String(string), S2Stream(this) { }

diff --git a/cores/esp8266/Updater.h b/cores/esp8266/Updater.h
@@ -108,12 +108,12 @@ class UpdaterClass {
     bool setMD5(const char * expected_md5);
 
     /*
-      returns the MD5 String of the sucessfully ended firmware
+      returns the MD5 String of the successfully ended firmware
     */
     String md5String(void){ return _md5.toString(); }
 
     /*
-      populated the result with the md5 bytes of the sucessfully ended firmware
+      populated the result with the md5 bytes of the successfully ended firmware
     */
     void md5(uint8_t * result){ return _md5.getBytes(result); }
 

diff --git a/cores/esp8266/core_esp8266_i2s.cpp b/cores/esp8266/core_esp8266_i2s.cpp
@@ -483,7 +483,7 @@ void i2s_set_dividers(uint8_t div1, uint8_t div2) {
   i2sc_temp |= (I2STXR); // Hold transmitter in reset
   I2SC = i2sc_temp;
 
-  // trans master(active low), recv master(active_low), !bits mod(==16 bits/chanel), clear clock dividers
+  // trans master(active low), recv master(active_low), !bits mod(==16 bits/channel), clear clock dividers
   i2sc_temp &= ~(I2STSM | I2SRSM | (I2SBMM << I2SBM) | (I2SBDM << I2SBD) | (I2SCDM << I2SCD));
 
   // I2SRF = Send/recv right channel first (? may be swapped form I2S spec of WS=0 => left)

diff --git a/cores/esp8266/core_esp8266_main.cpp b/cores/esp8266/core_esp8266_main.cpp
@@ -290,7 +290,7 @@ void init_done() {
    know if other features are using this, or if this memory is going to be
    used in future SDK releases.
 
-   WPS beeing flawed by its poor security, or not beeing used by lots of
+   WPS being flawed by its poor security, or not being used by lots of
    users, it has been decided that we are still going to use that memory for
    user's stack and disable the use of WPS.
 

diff --git a/cores/esp8266/core_esp8266_noniso.cpp b/cores/esp8266/core_esp8266_noniso.cpp
@@ -1,5 +1,5 @@
 /*
- core_esp8266_noniso.c - nonstandard (but usefull) conversion functions
+ core_esp8266_noniso.c - nonstandard (but useful) conversion functions
 
  Copyright (c) 2014 Ivan Grokhotkov. All rights reserved.
  This file is part of the esp8266 core for Arduino environment.

diff --git a/cores/esp8266/core_esp8266_phy.cpp b/cores/esp8266/core_esp8266_phy.cpp
@@ -289,7 +289,7 @@ static const uint8_t ICACHE_FLASH_ATTR phy_init_data[128] =
 };
 
 
-// These functions will be overriden from C++ code.
+// These functions will be overridden from C++ code.
 // Unfortunately, we can't use extern "C" because Arduino preprocessor
 // doesn't generate forward declarations for extern "C" functions correctly,
 // so we use mangled names here.

diff --git a/cores/esp8266/core_esp8266_version.h b/cores/esp8266/core_esp8266_version.h
@@ -1,4 +1,3 @@
-
 /*
  core_esp8266_version.h - parse "git describe" at compile time
  Copyright (c) 2018 david gauchard. All rights reserved.
@@ -159,7 +158,7 @@ int coreVersionSubRevision ()
 }
 
 /*
- * unique revision indentifier (never decreases)
+ * unique revision identifier (never decreases)
  */
 constexpr
 int coreVersionNumeric ()

diff --git a/cores/esp8266/core_esp8266_wiring.cpp b/cores/esp8266/core_esp8266_wiring.cpp
@@ -69,8 +69,8 @@ void micros_overflow_tick(void* arg) {
 //---------------------------------------------------------------------------
 // millis() 'magic multiplier' approximation
 //
-// This function corrects the cumlative (296us / usec overflow) drift
-// seen in the orignal 'millis()' function.
+// This function corrects the cumulative (296us / usec overflow) drift
+// seen in the original 'millis()' function.
 //
 // Input:
 //    'm' - 32-bit usec counter,           0 <= m <= 0xFFFFFFFF

diff --git a/cores/esp8266/esp8266_peri.h b/cores/esp8266/esp8266_peri.h
@@ -163,7 +163,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16];
 #define TCIS  8 //Interrupt Status
 #define TCTE  7 //Timer Enable
 #define TCAR  6 //AutoReload (restart timer when condition is reached)
-#define TCPD  2 //Prescale Devider (2bit) 0:1(12.5ns/tick), 1:16(0.2us/tick), 2/3:256(3.2us/tick)
+#define TCPD  2 //Prescale Divider (2bit) 0:1(12.5ns/tick), 1:16(0.2us/tick), 2/3:256(3.2us/tick)
 #define TCIT  0 //Interrupt Type 0:edge, 1:level
 
 //RTC Registers
@@ -271,7 +271,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16];
 #define UCRXI   19 //Invert RX
 #define UCTXRST 18 //Reset TX FIFO
 #define UCRXRST 17 //Reset RX FIFO
-#define UCTXHFE 15 //TX Harware Flow Enable
+#define UCTXHFE 15 //TX Hardware Flow Enable
 #define UCLBE   14 //LoopBack Enable
 #define UCBRK   8  //Send Break on the TX line
 #define UCSWDTR 7  //Set this bit to assert DTR
@@ -283,11 +283,11 @@ extern volatile uint32_t* const esp8266_gpioToFn[16];
 
 //UART CONF1 Registers Bits
 #define UCTOE   31 //RX TimeOut Enable
-#define UCTOT   24 //RX TimeOut Treshold (7bit)
-#define UCRXHFE 23 //RX Harware Flow Enable
-#define UCRXHFT 16 //RX Harware Flow Treshold (7bit)
-#define UCFET   8  //TX FIFO Empty Treshold (7bit)
-#define UCFFT   0  //RX FIFO Full Treshold (7bit)
+#define UCTOT   24 //RX TimeOut Threshold (7bit)
+#define UCRXHFE 23 //RX Hardware Flow Enable
+#define UCRXHFT 16 //RX Hardware Flow Threshold (7bit)
+#define UCFET   8  //TX FIFO Empty Threshold (7bit)
+#define UCFFT   0  //RX FIFO Full Threshold (7bit)
 
 //WDT Feed (the dog) Register
 #define WDTFEED    ESP8266_REG(0x914)
@@ -372,7 +372,7 @@ extern volatile uint32_t* const esp8266_gpioToFn[16];
 #define SPI1E3 		ESP8266_REG(0x1FC)
 #define SPI1W(p)  ESP8266_REG(0x140 + ((p & 0xF) * 4))
 
-//SPI0, SPI1 & I2S Interupt Register
+//SPI0, SPI1 & I2S Interrupt Register
 #define SPIIR     ESP8266_DREG(0x20)
 #define SPII0     4 //SPI0 Interrupt
 #define SPII1     7 //SPI1 Interrupt

diff --git a/cores/esp8266/esp8266_undocumented.h b/cores/esp8266/esp8266_undocumented.h
@@ -185,7 +185,7 @@ typedef void (*fn_c_exception_handler_t)(struct __exception_frame *ef, int cause
   _xtos_c_handler_table[]. It is present when an exception handler has not been
   registered. It simply consist of a single instruction, `ret`.
   It is also internally used by `_xtos_set_exception_handler(cause, NULL)` to
-  reset a "C" exception handler back to the unhandled state. The coresponding
+  reset a "C" exception handler back to the unhandled state. The corresponding
   `_xtos_exc_handler_table` entry will be set to `_xtos_unhandled_exception`.
   Note, if nesting handlers is desired this must be implemented in the new "C"
   exception handler(s) being registered.

diff --git a/cores/esp8266/exc-sethandler.cpp b/cores/esp8266/exc-sethandler.cpp
@@ -47,7 +47,7 @@
  *   https://github.com/qca/open-ath9k-htc-firmware/blob/master/sboot/magpie_1_1/sboot/athos/src/xtos/exc-sethandler.c
  *
  * It has been revised to use Arduino ESP8266 core includes, types, and
- * formating.
+ * formatting.
 */
 
 /* exc-sethandler.c - register an exception handler in XTOS */

diff --git a/cores/esp8266/gdb_hooks.h b/cores/esp8266/gdb_hooks.h
@@ -27,7 +27,7 @@ extern "C" {
  * @brief Initialize GDB stub, if present
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and does necessary initialization of that library.
+ * this function is overridden and does necessary initialization of that library.
  * Called early at startup.
  */
 void gdb_init(void);
@@ -36,7 +36,7 @@ void gdb_init(void);
  * @brief Break into GDB, if present
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and triggers entry into the debugger, which
+ * this function is overridden and triggers entry into the debugger, which
  * looks like a breakpoint hit.
  */
 void gdb_do_break(void);
@@ -45,7 +45,7 @@ void gdb_do_break(void);
  * @brief Check if GDB stub is present.
  * 
  * By default, this function returns false. When GDBStub library is linked,
- * this function is overriden and returns true. Can be used to check whether
+ * this function is overridden and returns true. Can be used to check whether
  * GDB is used.
  * 
  * @return true if GDB stub is present
@@ -58,7 +58,7 @@ bool gdb_present(void);
  * @brief Check if GDB is installing a putc1 callback.
  * 
  * By default, this function returns false. When GDBStub library is linked,
- * this function is overriden and returns true.
+ * this function is overridden and returns true.
  * 
  * @return true if GDB is installing a putc1 callback
  */
@@ -69,7 +69,7 @@ bool gdbstub_has_putc1_control(void);
  * @param func function GDB will proxy putc1 data to
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and sets GDB stub's secondary putc1 callback to
+ * this function is overridden and sets GDB stub's secondary putc1 callback to
  * func. When GDB stub is linked, but a GDB session is not current attached,
  * then GDB stub will pass putc1 chars directly to this function.
  */
@@ -79,7 +79,7 @@ void gdbstub_set_putc1_callback(void (*func)(char));
  * @brief Check if GDB is installing a uart0 isr callback.
  * 
  * By default, this function returns false. When GDBStub library is linked,
- * this function is overriden and returns true.
+ * this function is overridden and returns true.
  * 
  * @return true if GDB is installing a uart0 isr callback
  */
@@ -90,7 +90,7 @@ bool gdbstub_has_uart_isr_control(void);
  * @param func function GDB will proxy uart0 isr data to
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and sets GDB stub's secondary uart0 isr callback
+ * this function is overridden and sets GDB stub's secondary uart0 isr callback
  * to func. When GDB stub is linked, but a GDB session is not current attached,
  * then GDB stub will pass uart0 isr data back to this function.
  */
@@ -101,7 +101,7 @@ void gdbstub_set_uart_isr_callback(void (*func)(void*, uint8_t), void* arg);
  * @param c character to write
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and writes a char to either the GDB session on
+ * this function is overridden and writes a char to either the GDB session on
  * uart0 or directly to uart0 if not GDB session is attached.
  */
 void gdbstub_write_char(char c);
@@ -112,7 +112,7 @@ void gdbstub_write_char(char c);
  * @param size length of buffer
  * 
  * By default, this function is a no-op. When GDBStub library is linked,
- * this function is overriden and writes a buffer to either the GDB session on
+ * this function is overridden and writes a buffer to either the GDB session on
  * uart0 or directly to uart0 if not GDB session is attached.
  */
 void gdbstub_write(const char* buf, size_t size);

diff --git a/cores/esp8266/heap.cpp b/cores/esp8266/heap.cpp
@@ -42,7 +42,7 @@ extern "C" {
 #define UMM_REALLOC_FL(p,s,f,l) realloc(p,s)
 #define UMM_FREE_FL(p,f,l)      free(p)
 
-// STATIC_ALWAYS_INLINE only applys to the non-debug build path,
+// STATIC_ALWAYS_INLINE only applies to the non-debug build path,
 // it must not be enabled on the debug build path.
 #define STATIC_ALWAYS_INLINE static ALWAYS_INLINE
 #endif
@@ -226,10 +226,10 @@ void IRAM_ATTR print_oom_size(size_t size)
      b. Before, when the *alloc function creates a new, not modified, allocation.
 
      In a free() or realloc() call, the focus is on their allocation. It is
-     checked 1st and reported on 1ST if an error exists. Full Posion Check is
+     checked 1st and reported on 1ST if an error exists. Full Poison Check is
      done after.
 
-     For malloc(), calloc(), and zalloc() Full Posion Check is done 1st since
+     For malloc(), calloc(), and zalloc() Full Poison Check is done 1st since
      these functions do not modify an existing allocation.
 */
 void* IRAM_ATTR malloc(size_t size)

diff --git a/cores/esp8266/hwdt_app_entry.cpp b/cores/esp8266/hwdt_app_entry.cpp
@@ -376,7 +376,7 @@ extern hwdt_info_t hwdt_info;
 #undef hwdt_info_
 #undef hwdt_info
 #undef HWDT_VERIFY_HWDT_INFO
-static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and include verison of hwdt_info_t do not match.");
+static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and include version of hwdt_info_t do not match.");
 #endif
 
 
@@ -411,7 +411,7 @@ static_assert(sizeof(hwdt_info_t) == sizeof(LOCAL_HWDT_INFO_T), "Local and inclu
 #define CONT_STACK_A16_SZ  (MK_ALIGN16_SZ(sizeof(cont_t)))
 /*
  * For WPS support, cont stack comes out of the user's heap address space.
- * The the NONOS-SDK stack address is initialized before tbe reserved ROM stack
+ * The NONOS-SDK stack address is initialized before the reserved ROM stack
  * space. In this configuration there is no extra 4K in the heap.
  * Memory map: 0x3FFE8000, ..., (CONT_STACK), ..., (SYS), (ROM_STACK), 0x4000000
  *
@@ -764,8 +764,8 @@ void adjust_uart_speed(uint32_t uart_divisor) {
      * stablilize, and let the remote receiver come to an idle state before
      * continuing.
      *
-     * Load a Rubout character for the final charcter shifting out to stop
-     * the last charcter from getting crunched during the speed change.
+     * Load a Rubout character for the final character shifting out to stop
+     * the last character from getting crunched during the speed change.
      *
      * The thinking is if the speed changes while shifting out, as long as the
      * start bit gets out before the change. The change will not be noticed

diff --git a/cores/esp8266/interrupts.h b/cores/esp8266/interrupts.h
@@ -3,7 +3,7 @@
 
 #include <Arduino.h>
 
-// these auto classes wrap up xt_rsil so your code can be simplier, but can only be
+// these auto classes wrap up xt_rsil so your code can be simpler, but can only be
 // used in an ino or cpp files. 
 
 // InterruptLock is used when you want to completely disable interrupts

diff --git a/cores/esp8266/mmu_iram.cpp b/cores/esp8266/mmu_iram.cpp
@@ -80,7 +80,7 @@ extern "C" {
  *
  * "Cache_Read_Enable" is underdocumented. Main sources of information were from
  * rboot, zboot, https://richard.burtons.org/2015/06/12/esp8266-cache_read_enable/,
- * and other places. And some additional expermentation.
+ * and other places. And some additional experimentation.
  *
  * Searching through the NONOS SDK shows nothing on this API; however, some
  * clues on what the NONOS SDK might be doing with ICACHE related calls can be