Merge pull request #2 from cparata/main

Fix spell check errors

Author: cparata

extras/codespell-ignore-words-list.txt

@@ -1 +1,2 @@
-dout
+dout
+apon

src/rfal_rfst25r3916.cpp

@@ -870,7 +870,7 @@ ReturnCode RfalRfST25R3916Class::rfalStartTransceive(const rfalTransceiveContext
       /* Clear FIFO, Clear and Enable the Interrupts */
       rfalPrepareTransceive();
 
-      /* Disable our field upon a Rx reEnable on AP2P */
+      /* Disable our field upon a Rx re-enable on AP2P */
       if (rfalIsModeActiveComm(gRFAL.mode)) {
         st25r3916TxOff();
       }
@@ -1215,7 +1215,7 @@ void RfalRfST25R3916Class::rfalTransceiveTx(void)
   uint16_t          tmp;
   ReturnCode        ret;
 
-  /* Supress warning in case NFC-V feature is disabled */
+  /* Suppress warning in case NFC-V feature is disabled */
   ret = ERR_NONE;
   NO_WARNING(ret);
 
@@ -1560,7 +1560,7 @@ void RfalRfST25R3916Class::rfalTransceiveRx(void)
       }
 
       if ((irqs & ST25R3916_IRQ_MASK_RX_REST) != 0U) {
-        /* RX_REST indicates that Receiver has been reseted due to EMD, therefore a RXS + RXE should *
+        /* RX_REST indicates that Receiver has been reset due to EMD, therefore a RXS + RXE should *
          * follow if a good reception is followed within the valid initial timeout                   */
 
         /* Check whether NRT has expired already, if so signal a timeout */
@@ -2041,7 +2041,7 @@ ReturnCode RfalRfST25R3916Class::rfalISO14443ATransceiveShortFrame(rfal14443ASho
   /* Disable Collision interrupt */
   st25r3916DisableInterrupts((ST25R3916_IRQ_MASK_COL));
 
-  /* ReEnable CRC on Rx */
+  /* Re-enable CRC on Rx */
   st25r3916ClrRegisterBits(ST25R3916_REG_AUX, ST25R3916_REG_AUX_no_crc_rx);
 
   return ret;
@@ -2066,7 +2066,7 @@ ReturnCode RfalRfST25R3916Class::rfalISO14443ATransceiveAnticollisionFrame(uint8
   }
 
   /*******************************************************************************/
-  /* Set speficic Analog Config for Anticolission if needed */
+  /* Set specific Analog Config for Anticolission if needed */
   rfalSetAnalogConfig((RFAL_ANALOG_CONFIG_POLL | RFAL_ANALOG_CONFIG_TECH_NFCA | RFAL_ANALOG_CONFIG_BITRATE_COMMON | RFAL_ANALOG_CONFIG_ANTICOL));
 
 
@@ -2141,7 +2141,7 @@ ReturnCode RfalRfST25R3916Class::rfalISO14443ATransceiveAnticollisionFrame(uint8
   /* Disable anti collision again */
   st25r3916ClrRegisterBits(ST25R3916_REG_ISO14443A_NFC, ST25R3916_REG_ISO14443A_NFC_antcl);
 
-  /* ReEnable CRC on Rx */
+  /* Re-enable CRC on Rx */
   st25r3916ClrRegisterBits(ST25R3916_REG_AUX, ST25R3916_REG_AUX_no_crc_rx);
   /*******************************************************************************/
 
@@ -2165,7 +2165,7 @@ ReturnCode RfalRfST25R3916Class::rfalISO15693TransceiveAnticollisionFrame(uint8_
   }
 
   /*******************************************************************************/
-  /* Set speficic Analog Config for Anticolission if needed */
+  /* Set specific Analog Config for Anticolission if needed */
   rfalSetAnalogConfig((RFAL_ANALOG_CONFIG_POLL | RFAL_ANALOG_CONFIG_TECH_NFCV | RFAL_ANALOG_CONFIG_BITRATE_COMMON | RFAL_ANALOG_CONFIG_ANTICOL));
 
 
@@ -2298,7 +2298,7 @@ ReturnCode RfalRfST25R3916Class::rfalFeliCaPoll(rfalFeliCaPollSlots slots, uint1
         /* Upon timeout the full Poll Delay + (Slot time)*(nbSlots) has expired */
         timeout = true;
       } else {
-        /* Reception done, reEnabled Rx for following Slot */
+        /* Reception done, re-enabled Rx for following Slot */
         st25r3916ExecuteCommand(ST25R3916_CMD_UNMASK_RECEIVE_DATA);
         st25r3916ExecuteCommand(ST25R3916_CMD_RESET_RXGAIN);
 
@@ -2450,7 +2450,7 @@ ReturnCode RfalRfST25R3916Class::rfalWakeUpModeStart(const rfalWakeUpConfig *con
 
   /*******************************************************************************/
   /* Check if AAT is enabled. If so disable en bit to give time for the Voltage  *
-   * on the to varicaps to settle and have a stable reference measurment         */
+   * on the to varicaps to settle and have a stable reference measurement        */
   if (st25r3916CheckReg(ST25R3916_REG_IO_CONF2, ST25R3916_REG_IO_CONF2_aat_en, ST25R3916_REG_IO_CONF2_aat_en) && !gRFAL.wum.cfg.swTagDetect) {
     st25r3916ClrRegisterBits(ST25R3916_REG_OP_CONTROL, ST25R3916_REG_OP_CONTROL_en);
     delay(RFAL_ST25R3916_AAT_SETTLE_OFF);

src/rfal_rfst25r3916.h

@@ -119,7 +119,7 @@ typedef struct {
 
 /*! Struct that holds counters to control the FIFO on Tx and Rx                                                                          */
 typedef struct {
-  uint16_t                expWL;       /*!< The amount of bytes expected to be Tx when a WL interrupt occours                          */
+  uint16_t                expWL;       /*!< The amount of bytes expected to be Tx when a WL interrupt occurs                          */
   uint16_t                bytesTotal;  /*!< Total bytes to be transmitted OR the total bytes received                                  */
   uint16_t                bytesWritten;/*!< Amount of bytes already written on FIFO (Tx) OR read (RX) from FIFO and written on rxBuffer*/
   uint8_t                 status[ST25R3916_FIFO_STATUS_LEN];   /*!< FIFO Status Registers                                              */
@@ -315,7 +315,7 @@ typedef struct {
  * ISO15693 2000  8.4  t1 MIN = 4192/fc
  * ISO15693 2009  9.1  t1 MIN = 4320/fc
  * Digital 2.1 B.5 FDTV,LISTEN,MIN  = 4310/fc
- * Set FDT Listen one step earlier than on the more recent spec versions for greater interoprability
+ * Set FDT Listen one step earlier than on the more recent spec versions for greater interoperability
  */
 #define RFAL_FDT_LISTEN_V_ADJUSTMENT    64U
 
@@ -968,7 +968,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *
      *  This function the power level is measured in maximum load conditions and
      *  the regulated voltage reference is set to 250mV below this level.
-     *  Execution of this function lasts arround 5ms.
+     *  Execution of this function lasts around 5ms.
      *
      *  The regulated voltages will be set to the result of Adjust Regulators
      *
@@ -1354,7 +1354,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *  auto-increment feature. That is, after each read the address pointer
      *  inside the ST25R3916 gets incremented automatically.
      *
-     *  \param[in]  reg: Address of the frist register to read from.
+     *  \param[in]  reg: Address of the first register to read from.
      *  \param[in]  values: pointer to a buffer where the result shall be written to.
      *  \param[in]  length: Number of registers to be read out.
      *
@@ -1389,7 +1389,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *  auto-increment feature. That is, after each write the address pointer
      *  inside the ST25R3916 gets incremented automatically.
      *
-     *  \param[in]  reg: Address of the frist register to write.
+     *  \param[in]  reg: Address of the first register to write.
      *  \param[in]  values: pointer to a buffer containing the values to be written.
      *  \param[in]  length: Number of values to be written.
      *
@@ -1692,7 +1692,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *  \param[in] tmo : time in milliseconds until timeout occurs. If set to 0
      *                   the functions waits forever.
      *
-     *  \return : 0 if timeout occured otherwise a mask indicating the cleared
+     *  \return : 0 if timeout occurred otherwise a mask indicating the cleared
      *              interrupts.
      *
      *****************************************************************************
@@ -1704,7 +1704,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *  \brief  Get status for the given interrupt
      *
      *  This function is used to check whether the interrupt given by \a mask
-     *  has occured. If yes the interrupt gets cleared. This function returns
+     *  has occurred. If yes the interrupt gets cleared. This function returns
      *  only status bits which are inside \a mask.
      *
      *  \param[in] mask : mask indicating the interrupt to check for.
@@ -1720,7 +1720,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *  \brief  Init the 3916 interrupt
      *
      *  This function is used to check whether the interrupt given by \a mask
-     *  has occured.
+     *  has occurred.
      *
      *****************************************************************************
      */
@@ -1751,7 +1751,7 @@ class RfalRfST25R3916Class : public RfalRfClass {
      *****************************************************************************
      *  \brief  ISR Service routine
      *
-     *  This function modiefies the interupt
+     *  This function modiefies the interrupt
      *****************************************************************************
      */
     void  st25r3916Isr(void);

src/st25r3916.cpp

@@ -131,7 +131,7 @@ void RfalRfST25R3916Class::st25r3916Deinitialize(void)
 {
   st25r3916DisableInterrupts(ST25R3916_IRQ_MASK_ALL);
 
-  /* Disabe Tx and Rx, Keep OSC On */
+  /* Disable Tx and Rx, Keep OSC On */
   st25r3916TxRxOff();
 
   return;
@@ -253,7 +253,7 @@ ReturnCode RfalRfST25R3916Class::st25r3916CalibrateCapacitiveSensor(uint8_t *res
   /* Execute automatic calibration */
   ret = st25r3916ExecuteCommandAndGetResult(ST25R3916_CMD_CALIBRATE_C_SENSOR, ST25R3916_REG_CAP_SENSOR_RESULT, ST25R3916_TOUT_CALIBRATE_CAP_SENSOR, &res);
 
-  /* Check wether the calibration was successull */
+  /* Check whether the calibration was successull */
   if (((res & ST25R3916_REG_CAP_SENSOR_RESULT_cs_cal_end) != ST25R3916_REG_CAP_SENSOR_RESULT_cs_cal_end) ||
       ((res & ST25R3916_REG_CAP_SENSOR_RESULT_cs_cal_err) == ST25R3916_REG_CAP_SENSOR_RESULT_cs_cal_err) || (ret != ERR_NONE)) {
     return ERR_IO;

src/st25r3916.h

@@ -95,10 +95,10 @@ struct st25r3916StreamConfig {
 #define ST25R3916_CMD_RESPONSE_RF_COLLISION_N  0xC9U    /*!< NFC transmit with Response RF Collision Avoidance       */
 #define ST25R3916_CMD_GOTO_SENSE               0xCDU    /*!< Passive target logic to Sense/Idle state                */
 #define ST25R3916_CMD_GOTO_SLEEP               0xCEU    /*!< Passive target logic to Sleep/Halt state                */
-#define ST25R3916_CMD_MASK_RECEIVE_DATA        0xD0U    /*!< Mask recive data                                        */
-#define ST25R3916_CMD_UNMASK_RECEIVE_DATA      0xD1U    /*!< Unmask recive data                                      */
+#define ST25R3916_CMD_MASK_RECEIVE_DATA        0xD0U    /*!< Mask receive data                                        */
+#define ST25R3916_CMD_UNMASK_RECEIVE_DATA      0xD1U    /*!< Unmask receive data                                      */
 #define ST25R3916_CMD_AM_MOD_STATE_CHANGE      0xD2U    /*!< AM Modulation state change                              */
-#define ST25R3916_CMD_MEASURE_AMPLITUDE        0xD3U    /*!< Measure singal amplitude on RFI inputs                  */
+#define ST25R3916_CMD_MEASURE_AMPLITUDE        0xD3U    /*!< Measure signal amplitude on RFI inputs                  */
 #define ST25R3916_CMD_RESET_RXGAIN             0xD5U    /*!< Reset RX Gain                                           */
 #define ST25R3916_CMD_ADJUST_REGULATORS        0xD6U    /*!< Adjust regulators                                       */
 #define ST25R3916_CMD_CALIBRATE_DRIVER_TIMING  0xD8U    /*!< Starts the sequence to adjust the driver timing         */