Merge pull request #21 from arduino/ci-spell-check

[CI] add spell-check action for checking spelling, grammar, etc.

Author: aentinger

.codespellrc

@@ -0,0 +1,9 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/spell-check/.codespellrc
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = hsi,
+skip = ./.git,./.licenses,__pycache__,node_modules,./go.mod,./go.sum,./package-lock.json,./poetry.lock,./yarn.lock,./libraries
+builtin = clear,informal,en-GB_to_en-US
+check-filenames =
+check-hidden =

.github/workflows/spell-check.yml

@@ -0,0 +1,22 @@
+name: Spell Check
+
+# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
+on:
+  push:
+  pull_request:
+  schedule:
+    # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates.
+    - cron: "0 8 * * TUE"
+  workflow_dispatch:
+  repository_dispatch:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Spell check
+        uses: codespell-project/actions-codespell@master

README.md

@@ -1,6 +1,7 @@
 :floppy_disk: `portentax8-stm32h7-fw`
 =====================================
 [![Smoke test status](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/smoke-test.yml/badge.svg)](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/smoke-test.yml)
+[![Spell Check status](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/spell-check.yml)
 [![Sync Labels status](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino/portentax8-stm32h7-fw/actions/workflows/sync-labels.yml)
 
 This repository contains the firmware running on the `STM32H747AIIX`/Cortex-M7 core which, in combination with loadable kernel modules within the Linux distribution, provides access to various IO busses on the expansion headers of the Portenta X8.
@@ -33,7 +34,7 @@ cd /usr/arduino/extra
 sudo ./program.sh
 ```
 ### IMX8 / H7 Interface Block Diagram
-Every communication is initated by the IMX8 who serves as SPI controller. This happens either by the user issueing a `write` call on any of the interfaces or by the H7 requesting the start of a communication by setting `IRQ` to `1`. A detailed description of the used protocol can be found [here](doc/protocol.md).
+Every communication is initiated by the IMX8 who serves as SPI controller. This happens either by the user issuing a `write` call on any of the interfaces or by the H7 requesting the start of a communication by setting `IRQ` to `1`. A detailed description of the used protocol can be found [here](doc/protocol.md).
 <p align="center">
   <img src="doc/img/portenta-x8h7-interface-block-diagram.png" width="75%">
 </p>

include/ringbuffer.h

@@ -40,7 +40,7 @@
 
 /**
  * The type which is used to hold the size
- * and the indicies of the buffer.
+ * and the indices of the buffer.
  * Must be able to fit \c RING_BUFFER_SIZE .
  */
 typedef uint16_t ring_buffer_size_t;

scripts/program-h7.sh

@@ -5,7 +5,7 @@ echo 15 > /sys/class/gpio/export # SWDCLK
 echo 10 > /sys/class/gpio/export # NRST
 echo 11 > /sys/class/gpio/export # BOOT0
 
-# Try at least three times to read firware version from sysfs
+# Try at least three times to read firmware version from sysfs
 for i in 1 2 3
 do
     FIRMWARE_H7_ON_MCU=$(cat /sys/kernel/x8h7_firmware/version)

src/can.c

@@ -322,7 +322,7 @@ void can_init(can_t *obj, CANName peripheral, CanNominalBitTimingResult const ca
     /* Message RAM offset is only supported in STM32H7 platforms of supported FDCAN platforms */
     obj->CanHandle.Init.MessageRAMOffset = 0;
 
-    /* The number of Standard and Extended ID filters are initialized to the maximum possile extent
+    /* The number of Standard and Extended ID filters are initialized to the maximum possible extent
      * for STM32H7 platforms
      */
     obj->CanHandle.Init.StdFiltersNbr = 128; // to be aligned with the handle parameter in can_filter

src/gpio.c

@@ -261,7 +261,7 @@ void gpio_handler(uint8_t opcode, uint8_t *pdata, uint16_t size) {
       dbg_printf("GPIO%d: IRQ_ACK %d\n", index, value);
       /* Re-enable the interrupt that was disabled within
        * handle_irq to prevent firing of another interrupt
-       * until this one has been signalled to the application.
+       * until this one has been signaled to the application.
        */
       gpio_enable_irq(GPIO_pinmap[index].pin);
       break;
@@ -311,7 +311,7 @@ void gpio_handle_data()
   /* We have a total of 10 external interrupts. */
   for (uint8_t index = 0; index < 10; index++)
   {
-    /* Check whether or not an external interrupt has occured. */
+    /* Check whether or not an external interrupt has occurred. */
     if (copy_int_event_flags & (1 << index))
     {
       uint8_t irq_pin = IRQ_pinmap[index].pin;

src/system.c

@@ -265,7 +265,7 @@ void enqueue_packet(uint8_t peripheral, uint8_t opcode, uint16_t size, void* dat
   /* Copy subpacket.raw_data at after subpacket.header. */
   memcpy((uint8_t*)&(tx_pkt->data) + tx_pkt->header.size, data, size);
   tx_pkt->header.size += size;
-  /* Calculate a simple checksum to ensure bit flips in the length field can be recognised. */
+  /* Calculate a simple checksum to ensure bit flips in the length field can be recognized. */
   tx_pkt->header.checksum = tx_pkt->header.size ^ 0x5555;
 
   dbg_printf("Enqueued packet for peripheral: %s Opcode: %X Size: %X\n  data: ",
@@ -379,7 +379,7 @@ void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi) {
     get_data_amount = false;
 
   } else {
-    // real end of operation, pause DMA, memcpy stuff around and reenable DMA
+    // real end of operation, pause DMA, memcpy stuff around and re-enable DMA
     // HAL_SPI_DMAPause(&hspi1);
 
     transferState = TRANSFER_COMPLETE;

src/uart.c

@@ -72,7 +72,7 @@ int _write(int file, char *ptr, int len)
   __disable_irq();
   /* Enqueue data to write into ringbuffer. */
   ring_buffer_queue_arr(&uart_tx_ring_buffer, ptr, len);
-  /* Reenable interrupts. */
+  /* Re-enable interrupts. */
   __enable_irq();
   return len;
 }