Spell check, link checking and CI (#44)

* Spell check and add codespell * Add link checking CI, and missing files
analogdevicesinc · Mar 22, 2023 · 7f2128c · 7f2128c
1 parent 686448a
commit 7f2128c
Show file tree

Hide file tree

Showing 146 changed files with 407 additions and 366 deletions.
diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml
@@ -0,0 +1,31 @@
+---
+name: Lint code
+
+on:
+  push:
+    branches-ignore: [test]
+  pull_request:
+    branches-ignore: [test]
+
+jobs:
+  build:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install codespell
+        run: pip install codespell tomli
+
+      - name: Run codespell
+        run: codespell
+
+      - name: Install markdown-lint-check
+        run: npm install -g markdown-link-check
+
+      - name: Run markdown-lint-check
+        run: find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check -a 0 -p -v -r
diff --git a/.github/workflows/no_pull_requests_to_main.yml b/.github/workflows/no_pull_requests_to_main.yml
@@ -1,4 +1,4 @@
-# This is a basic workflow to thow an error if a pull request targets the main and historic branches
+# This is a basic workflow to throw an error if a pull request targets the main and historic branches
 
 name: No Pull Requests to Main and Historic Branches
 

diff --git a/archive/maxrefdes178-ASL/README.md b/archive/maxrefdes178-ASL/README.md
@@ -8,7 +8,7 @@
 
 Please refer to main MAXREFDES178 documentation for instructions how to build, and load firmware:
 
-[Getting Started with the MAXREFDES178# Cube Camera](./../maxrefdes178_doc/README.md)
+[Getting Started with the MAXREFDES178# Cube Camera](../../maxrefdes178_doc/README.md)
 
 Please note that ASL demo does not support Android application.
 

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/Makefile b/archive/maxrefdes178-ASL/maxrefdes178_max32666/Makefile
@@ -1,5 +1,5 @@
 ################################################################################
- # Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
+ # Copyright (C) 2016-2023 Maxim Integrated Products, Inc., All Rights Reserved.
  #
  # Permission is hereby granted, free of charge, to any person obtaining a
  # copy of this software and associated documentation files (the "Software"),
@@ -102,7 +102,7 @@ ifeq ($(MAKECMDGOALS),sla)
 SRCS += sla_header.c
 endif
 
-# External libray source files
+# External library source files
 SRCS += bmi160.c
 
 # Where to find source files for this test
@@ -188,7 +188,7 @@ export PERIPH_DRIVER_DIR
 #CORDIO_DIR=Cordio
 #include $(CORDIO_DIR)/platform/targets/maxim/build/cordio.mk
 
-# Inlcude USB Library
+# Include USB Library
 #MAXUSB_DIR=$(LIBS_DIR)/MAXUSB
 #include $(MAXUSB_DIR)/maxusb.mk
 

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/include/max32666_i2c.h b/archive/maxrefdes178-ASL/maxrefdes178_max32666/include/max32666_i2c.h
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+* Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
 *
 * This software is protected by copyright laws of the United States and
 * of foreign countries. This material may also be protected by patent laws
@@ -125,7 +125,7 @@ int i2c_master_reg_read_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len
 
 /**
  * @brief  Initialize I2C peripheral
- * @retval     #E_NO_ERROR   Intialization successful.
+ * @retval     #E_NO_ERROR   Initialization successful.
  * @retval     "Error Code"  @ref MXC_Error_Codes "Error Code" if unsuccessful.
  */
 int i2c_master_init(void);

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/include/max32666_pmic.h b/archive/maxrefdes178-ASL/maxrefdes178_max32666/include/max32666_pmic.h
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+* Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
 *
 * This software is protected by copyright laws of the United States and
 * of foreign countries. This material may also be protected by patent laws
@@ -53,15 +53,15 @@
 /**
  * @brief  Initialize MAX20303 PMIC. Before calling this function, I2C should
  * be initialized via i2c_init() function.
- * @retval     #E_NO_ERROR   Intialization successful.
+ * @retval     #E_NO_ERROR   Initialization successful.
  * @retval     "Error Code"  @ref MXC_Error_Codes "Error Code" if unsuccessful.
  */
 int pmic_init(void);
 
 /**
  * @brief  Worker function for MAX20303 PMIC. Before calling this function, I2C should
  * be initialized via i2c_init() function.
- * @retval     #E_NO_ERROR   Intialization successful.
+ * @retval     #E_NO_ERROR   Initialization successful.
  * @retval     "Error Code"  @ref MXC_Error_Codes "Error Code" if unsuccessful.
  */
 int pmic_worker(void);

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/maxrefdes178_max32666.ld b/archive/maxrefdes178-ASL/maxrefdes178_max32666/maxrefdes178_max32666.ld
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
+ * Copyright (C) 2017-2023 Maxim Integrated Products, Inc., All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -218,7 +218,7 @@ SECTIONS {
     {
         . = ALIGN(4);
         _bss = .;
-        *(.bss*)     /*read-write zero initialized data: uninitialzed global variable*/
+        *(.bss*)     /*read-write zero initialized data: uninitialized global variable*/
         *(COMMON)
         _ebss = ALIGN(., 4);
     } > SRAM

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_ble.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_ble.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -689,7 +689,7 @@ int ble_send_indication(uint16_t dataLen, uint8_t *data)
         }
     }
 
-    PR_ERROR("indication couldnt sent");
+    PR_ERROR("indication couldn't be sent");
 
     return E_COMM_ERR;
 }

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_ble_command.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_ble_command.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -452,7 +452,7 @@ static int ble_command_execute_rx_command(void)
         expander_select_debugger((debugger_select_e)ble_command_buffer.total_payload_buffer[0]);
         break;
     default:
-        PR_ERROR("Unknwon command");
+        PR_ERROR("Unknown command");
         break;
     }
 

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_lcd.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_lcd.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -210,7 +210,7 @@ static int lcd_configure(void)
     lcd_sendSmallData(0x01);           //  Default value
 
     lcd_sendCommand(0xC3);             //  VRH set
-    lcd_sendSmallData(0x12);           //  +-4.45v (defalut +-4.1v for 0x0B)
+    lcd_sendSmallData(0x12);           //  +-4.45v (default +-4.1v for 0x0B)
 
     lcd_sendCommand(0xC4);             //  VDV set
     lcd_sendSmallData(0x20);           //  Default value

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_main.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_main.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -806,7 +806,7 @@ static int refresh_screen(void)
         if ((timestamps.screen_drew - timestamps.audio_result_received) < LCD_CLASSIFICATION_DURATION) {
             if (device_settings.enable_lcd_probabilty) {
                 snprintf(lcd_string_buff, sizeof(lcd_string_buff) - 1, "%s (%d%%)",
-                        device_status.classification_audio.result, (uint8_t) device_status.classification_audio.probabily);
+                        device_status.classification_audio.result, (uint8_t) device_status.classification_audio.probability);
             } else {
                 strncpy(lcd_string_buff, device_status.classification_audio.result, sizeof(lcd_string_buff) - 1);
             }

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_qspi_master.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_qspi_master.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -237,7 +237,7 @@ int qspi_master_video_rx_worker(qspi_packet_type_e *qspi_packet_type_rx)
         spi_dma_wait(MAX32666_QSPI_DMA_CHANNEL, MAX32666_QSPI);
         GPIO_SET(video_cs_pin);
 
-        PR_INFO("video %s %d %0.1f", device_status.classification_video.result, device_status.classification_video.classification, (double)device_status.classification_video.probabily);
+        PR_INFO("video %s %d %0.1f", device_status.classification_video.result, device_status.classification_video.classification, (double)device_status.classification_video.probability);
 
         break;
     case QSPI_PACKET_TYPE_VIDEO_STATISTICS_RES:
@@ -425,7 +425,7 @@ int qspi_master_audio_rx_worker(qspi_packet_type_e *qspi_packet_type_rx)
         spi_dma_wait(MAX32666_QSPI_DMA_CHANNEL, MAX32666_QSPI);
         GPIO_SET(audio_cs_pin);
 
-        PR_INFO("audio %s %d %0.1f", device_status.classification_audio.result, device_status.classification_audio.classification, (double)device_status.classification_audio.probabily);
+        PR_INFO("audio %s %d %0.1f", device_status.classification_audio.result, device_status.classification_audio.classification, (double)device_status.classification_audio.probability);
 
         break;
     case QSPI_PACKET_TYPE_AUDIO_STATISTICS_RES:

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_sdcard.c b/archive/maxrefdes178-ASL/maxrefdes178_max32666/src/max32666_sdcard.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -239,7 +239,7 @@ static int sdcard_example(void)
     }
 
     PR_INFO("Renaming File...");
-    if((err = f_rename("0:HelloWorld.txt", "0:MaximSDHC/HelloMaxim.txt")) != FR_OK){ //cr: clearify 0:file notation
+    if((err = f_rename("0:HelloWorld.txt", "0:MaximSDHC/HelloMaxim.txt")) != FR_OK){ //cr: clarify 0:file notation
         PR_ERROR("Error moving file: %s", FF_ERRORS[err]);
         f_mount(NULL, "", 0);
         return err;

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max78000_audio/maxrefdes178_max78000_audio.ld b/archive/maxrefdes178-ASL/maxrefdes178_max78000_audio/maxrefdes178_max78000_audio.ld
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
+ * Copyright (C) 2016-2023 Maxim Integrated Products, Inc., All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -36,7 +36,7 @@ FLASH_SIZE = 0x00080000; /* 512kB Flash */
 
 BOOTLOADER_SIZE = 0x8000; /* 32k for flash bootloader */
 BOOTMEM_SIZE = 0x40; /* 64 bytes of memory for flash bootloader */
-ROM_BL_PAGE_SIZE = 0x2000; /* Last page is used by ROM bootlaoder */
+ROM_BL_PAGE_SIZE = 0x2000; /* Last page is used by ROM bootloader */
 MAINAPP_SIZE = FLASH_SIZE - BOOTLOADER_SIZE - BOOTMEM_SIZE - ROM_BL_PAGE_SIZE;
 
 BOOTLOADER_ORIGIN = FLASH_ORIGIN;
@@ -155,7 +155,7 @@ SECTIONS {
     {
         . = ALIGN(4);
         _bss = .;
-        *(.bss*)     /*read-write zero initialized data: uninitialzed global variable*/
+        *(.bss*)     /*read-write zero initialized data: uninitialized global variable*/
         *(COMMON)
         _ebss = ALIGN(., 4);
     } > SRAM
@@ -166,7 +166,7 @@ SECTIONS {
         _shared = .;
         *(.mailbox*)
         . = ALIGN(4);
-        *(.shared*)     /*read-write zero initialized data: uninitialzed global variable*/
+        *(.shared*)     /*read-write zero initialized data: uninitialized global variable*/
         _eshared = ALIGN(., 4);
     } > SRAM
     __shared_data = LOADADDR(.shared);

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max78000_audio/src/max78000_audio_main.c b/archive/maxrefdes178-ASL/maxrefdes178_max78000_audio/src/max78000_audio_main.c
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+ * Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
  *
  * This software is protected by copyright laws of the United States and
  * of foreign countries. This material may also be protected by patent laws
@@ -636,7 +636,7 @@ int main(void)
                 }
 
                 memcpy(classification_result.result, keywords[out_class], sizeof(classification_result.result));
-                classification_result.probabily = probability;
+                classification_result.probability = probability;
 
                 qspi_slave_send_packet((uint8_t *) &classification_result, sizeof(classification_result),
                         QSPI_PACKET_TYPE_AUDIO_CLASSIFICATION_RES);
@@ -747,7 +747,7 @@ static uint8_t cnn_load_data(uint8_t* pIn)
     uint32_t mem;
     uint16_t index = 0;
 
-    /* data should already be formated correctly */
+    /* data should already be formatted correctly */
     /* pIn is 16KB, each 1KB belongs to a memory group */
     for (mem = 0x50400000; mem <= 0x50418000; mem += 0x8000) {
         memcpy((uint8_t*)mem, &pIn[index], 1024);
@@ -777,7 +777,7 @@ static uint8_t AddTranspose(uint8_t *pIn, uint8_t *pOut, uint16_t inSize,
         uint16_t outSize, uint16_t width) {
     /* Data order in Ai85 memory (transpose is included):
 	input(series of 8 bit samples): (0,0) ...  (0,127)  (1,0) ... (1,127) ...... (127,0)...(127,127)    16384 samples
-	output (32bit word): 16K samples in a buffer. Later, each 1K goes to a seperate CNN memory group
+	output (32bit word): 16K samples in a buffer. Later, each 1K goes to a separate CNN memory group
 	0x0000:
 		(0,3)(0,2)(0,1)(0,0)
 		(0,67)(0,66)(0,65)(0,64)

diff --git a/archive/maxrefdes178-ASL/maxrefdes178_max78000_video/maxrefdes178_max78000_video.ld b/archive/maxrefdes178-ASL/maxrefdes178_max78000_video/maxrefdes178_max78000_video.ld
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (C) Maxim Integrated Products, Inc., All Rights Reserved.
+ * Copyright (C) 2016-2023 Maxim Integrated Products, Inc., All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -36,7 +36,7 @@ FLASH_SIZE = 0x00080000; /* 512kB Flash */
 
 BOOTLOADER_SIZE = 0x8000; /* 32k for flash bootloader */
 BOOTMEM_SIZE = 0x40; /* 64 bytes of memory for flash bootloader */
-ROM_BL_PAGE_SIZE = 0x2000; /* Last page is used by ROM bootlaoder */
+ROM_BL_PAGE_SIZE = 0x2000; /* Last page is used by ROM bootloader */
 MAINAPP_SIZE = FLASH_SIZE - BOOTLOADER_SIZE - BOOTMEM_SIZE - ROM_BL_PAGE_SIZE;
 
 BOOTLOADER_ORIGIN = FLASH_ORIGIN;
@@ -155,7 +155,7 @@ SECTIONS {
     {
         . = ALIGN(4);
         _bss = .;
-        *(.bss*)     /*read-write zero initialized data: uninitialzed global variable*/
+        *(.bss*)     /*read-write zero initialized data: uninitialized global variable*/
         *(COMMON)
         _ebss = ALIGN(., 4);
     } > SRAM
@@ -166,7 +166,7 @@ SECTIONS {
         _shared = .;
         *(.mailbox*)
         . = ALIGN(4);
-        *(.shared*)     /*read-write zero initialized data: uninitialzed global variable*/
+        *(.shared*)     /*read-write zero initialized data: uninitialized global variable*/
         _eshared = ALIGN(., 4);
     } > SRAM
     __shared_data = LOADADDR(.shared);

diff --git a/maxrefdes178-AIPortrait/README.md b/maxrefdes178-AIPortrait/README.md
@@ -6,7 +6,7 @@
 
 Please refer to main MAXREFDES178 documentation for instructions how to build, and load firmware:
 
-[Getting Started with the MAXREFDES178# Cube Camera](./../maxrefdes178_doc/README.md)
+[Getting Started with the MAXREFDES178# Cube Camera](../maxrefdes178_doc/README.md)
 
 NOTE: This demo does not support Android application.
 

diff --git a/maxrefdes178-AIPortrait/maxrefdes178_max32666/Makefile b/maxrefdes178-AIPortrait/maxrefdes178_max32666/Makefile
@@ -1,5 +1,5 @@
 ################################################################################
- # Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
+ # Copyright (C) 2016-2023 Maxim Integrated Products, Inc., All Rights Reserved.
  #
  # Permission is hereby granted, free of charge, to any person obtaining a
  # copy of this software and associated documentation files (the "Software"),
@@ -114,7 +114,7 @@ ifeq ($(MAKECMDGOALS),sla)
 SRCS += sla_header.c
 endif
 
-# External libray source files
+# External library source files
 SRCS += bmi160.c
 
 # Where to find source files for this test
@@ -200,7 +200,7 @@ export PERIPH_DRIVER_DIR
 #CORDIO_DIR=Cordio
 #include $(CORDIO_DIR)/platform/targets/maxim/build/cordio.mk
 
-# Inlcude USB Library
+# Include USB Library
 #MAXUSB_DIR=$(LIBS_DIR)/MAXUSB
 #include $(MAXUSB_DIR)/maxusb.mk
 

diff --git a/maxrefdes178-AIPortrait/maxrefdes178_max32666/include/max32666_i2c.h b/maxrefdes178-AIPortrait/maxrefdes178_max32666/include/max32666_i2c.h
@@ -1,5 +1,5 @@
 /*******************************************************************************
-* Copyright (C) 2020-2021 Maxim Integrated Products, Inc., All rights Reserved.
+* Copyright (C) 2020-2023 Maxim Integrated Products, Inc., All rights Reserved.
 *
 * This software is protected by copyright laws of the United States and
 * of foreign countries. This material may also be protected by patent laws
@@ -125,7 +125,7 @@ int i2c_master_reg_read_buf(uint8_t addr, uint8_t reg, uint8_t *buf, uint8_t len
 
 /**
  * @brief  Initialize I2C peripheral
- * @retval     #E_NO_ERROR   Intialization successful.
+ * @retval     #E_NO_ERROR   Initialization successful.
  * @retval     "Error Code"  @ref MXC_Error_Codes "Error Code" if unsuccessful.
  */
 int i2c_master_init(void);