clean up comments

contributions are tracked by commit history and contributors are acknowledged in the ACKNOWLEDGEMENTS.md file

Author: oclyke

cores/arduino/am_sdk_ap3/mcu/apollo3/hal/am_hal_pin.h

@@ -48,9 +48,6 @@
 //
 //*****************************************************************************
 
-//2020-03-25, Stephen Fordyce: Checked against Apollo3 datasheet DS-A3-0p9p1 Table 559 (p381) and fixed.  To see fixes, search "Fixed" in the below.
-
-
 #ifndef AM_HAL_PIN_H
 #define AM_HAL_PIN_H
 
@@ -73,7 +70,7 @@
 #define AM_HAL_PIN_1_MSPI5        (5)
 #define AM_HAL_PIN_1_NCE1         (7)
 
-#define AM_HAL_PIN_2_UART1RX	  (0) //Fixed (added) SF 2020-03-25
+#define AM_HAL_PIN_2_UART1RX      (0)
 #define AM_HAL_PIN_2_SLMISO       (1)
 #define AM_HAL_PIN_2_UART0RX      (2)
 #define AM_HAL_PIN_2_GPIO         (3)
@@ -89,12 +86,11 @@
 #define AM_HAL_PIN_3_I2S_WCLK     (7)
 #define AM_HAL_PIN_3_PSOURCE      (3)
 
-#define AM_HAL_PIN_4_UART0CTS     (0)	
+#define AM_HAL_PIN_4_UART0CTS     (0)
 #define AM_HAL_PIN_4_SLINT        (1)
 #define AM_HAL_PIN_4_NCE4         (2)
 #define AM_HAL_PIN_4_GPIO         (3)
-//#define AM_HAL_PIN_4_UART0RX      (5)	//Fixed (removed) SF 2020-03-25
-#define	AM_HAL_PIN_4_UART1RX	  (5)	//Fixed (added) SF 2020-03-25
+#define	AM_HAL_PIN_4_UART1RX      (5)
 #define AM_HAL_PIN_4_CTIM17       (6)
 #define AM_HAL_PIN_4_MSPI2        (7)
 
@@ -134,7 +130,7 @@
 #define AM_HAL_PIN_9_SCCIO        (4)
 #define AM_HAL_PIN_9_UART1RX      (6)
 
-#define AM_HAL_PIN_10_UART1TX	  (0)	//Fixed (added) SF 2020-03-25
+#define AM_HAL_PIN_10_UART1TX     (0)
 #define AM_HAL_PIN_10_M1MOSI      (1)
 #define AM_HAL_PIN_10_NCE10       (2)
 #define AM_HAL_PIN_10_GPIO        (3)
@@ -443,8 +439,7 @@
 #define AM_HAL_PIN_44_CTIM20      (2)
 #define AM_HAL_PIN_44_GPIO        (3)
 #define AM_HAL_PIN_44_M4MOSI      (5)
-#define AM_HAL_PIN_44_M5nCE6      (6)	//Original, doesn't match Apollo 3 pin mapping table
-#define AM_HAL_PIN_44_UART0TX     (6)	//Fixed (added) SF 2020-03-25
+#define AM_HAL_PIN_44_UART0TX     (6)
 
 #if defined (AM_PACKAGE_BGA)
 #define AM_HAL_PIN_45_UART1CTS    (0)

cores/arduino/ard_sup/ap3_uart_types.h

@@ -20,24 +20,18 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-//2020-03-25, Stephen Fordyce: Checked against Apollo3 datasheet DS-A3-0p9p1 Table 559 (p381) and fixed.  To see fixes, search "Fixed" in the below.
-
 #ifndef _AP3_UART_TYPES_H_
 #define _AP3_UART_TYPES_H_
 
 #define AP3_UART_PIN_UNUSED 0xFF
 
-//#define AP3_UART0_NUM_TX_PADS 11	//Fixed (removed) SF 2020-03-25
-#define AP3_UART0_NUM_TX_PADS 12	//Fixed (added) SF 2020-03-25
-//#define AP3_UART0_NUM_RX_PADS 13	//Fixed (removed) SF 2020-03-25
-#define AP3_UART0_NUM_RX_PADS 12	//Fixed (added) SF 2020-03-25
+#define AP3_UART0_NUM_TX_PADS 12
+#define AP3_UART0_NUM_RX_PADS 12
 #define AP3_UART0_NUM_RTS_PADS 8
 #define AP3_UART0_NUM_CTS_PADS 8
 
-//#define AP3_UART1_NUM_TX_PADS 11	//Fixed (removed) SF 2020-03-25
-#define AP3_UART1_NUM_TX_PADS 12	//Fixed (added) SF 2020-03-25
-//#define AP3_UART1_NUM_RX_PADS 11	//Fixed (removed) SF 2020-03-25
-#define AP3_UART1_NUM_RX_PADS 13	//Fixed (added) SF 2020-03-25
+#define AP3_UART1_NUM_TX_PADS 12
+#define AP3_UART1_NUM_RX_PADS 13
 #define AP3_UART1_NUM_RTS_PADS 8
 #define AP3_UART1_NUM_CTS_PADS 8
 

cores/arduino/ard_sup/uart/ap3_uart_structures.c

@@ -20,8 +20,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-//2020-03-25, Stephen Fordyce: Checked against Apollo3 datasheet DS-A3-0p9p1 Table 559 (p381) and fixed.  To see fixes, search "Fixed" in the below.
-
 // #include "ap3_uart.h"
 #include "ap3_types.h"
 #include "ap3_uart_types.h"
@@ -37,13 +35,12 @@ const ap3_uart_pad_map_elem_t ap3_uart0_tx_map[AP3_UART0_NUM_TX_PADS] = {
     {.pad = 30, .funcsel = AM_HAL_PIN_30_UART0TX},
     {.pad = 39, .funcsel = AM_HAL_PIN_39_UART0TX},
     {.pad = 41, .funcsel = AM_HAL_PIN_41_UART0TX},
-	{.pad = 44, .funcsel = AM_HAL_PIN_44_UART0TX}, //Fixed (added) SF 2020-03-25
+	{.pad = 44, .funcsel = AM_HAL_PIN_44_UART0TX},
     {.pad = 48, .funcsel = AM_HAL_PIN_48_UART0TX},
 };
 
 const ap3_uart_pad_map_elem_t ap3_uart0_rx_map[AP3_UART0_NUM_RX_PADS] = {
     {.pad = 2, .funcsel = AM_HAL_PIN_2_UART0RX},
-    //{.pad = 4, .funcsel = AM_HAL_PIN_4_UART0RX},	//Fixed (removed) SF 2020-03-25
     {.pad = 11, .funcsel = AM_HAL_PIN_11_UART0RX},
     {.pad = 17, .funcsel = AM_HAL_PIN_17_UART0RX},
     {.pad = 21, .funcsel = AM_HAL_PIN_21_UART0RX},
@@ -75,14 +72,13 @@ const ap3_uart_pad_map_elem_t ap3_uart0_cts_map[AP3_UART0_NUM_CTS_PADS] = {
     {.pad = 24, .funcsel = AM_HAL_PIN_24_UART0CTS},
     {.pad = 29, .funcsel = AM_HAL_PIN_29_UART0CTS},
     {.pad = 33, .funcsel = AM_HAL_PIN_33_UART0CTS},
-    //{.pad = 26, .funcsel = AM_HAL_PIN_36_UART0CTS},	//Fixed (removed) SF 2020-03-25
-	{.pad = 36, .funcsel = AM_HAL_PIN_36_UART0CTS},	//Fixed (replaced with .pad=36 instead of =26) SF 2020-03-25
+	{.pad = 36, .funcsel = AM_HAL_PIN_36_UART0CTS},
     {.pad = 38, .funcsel = AM_HAL_PIN_38_UART0CTS},
 };
 
 const ap3_uart_pad_map_elem_t ap3_uart1_tx_map[AP3_UART1_NUM_TX_PADS] = {
     {.pad = 8, .funcsel = AM_HAL_PIN_8_UART1TX},
-	{.pad = 10, .funcsel = AM_HAL_PIN_10_UART1TX},	//Fixed (added) SF 2020-03-25
+	{.pad = 10, .funcsel = AM_HAL_PIN_10_UART1TX},
     {.pad = 12, .funcsel = AM_HAL_PIN_12_UART1TX},
     {.pad = 14, .funcsel = AM_HAL_PIN_14_UART1TX},
     {.pad = 18, .funcsel = AM_HAL_PIN_18_UART1TX},
@@ -96,8 +92,8 @@ const ap3_uart_pad_map_elem_t ap3_uart1_tx_map[AP3_UART1_NUM_TX_PADS] = {
 };
 
 const ap3_uart_pad_map_elem_t ap3_uart1_rx_map[AP3_UART1_NUM_RX_PADS] = {
-    {.pad = 2, .funcsel = AM_HAL_PIN_2_UART1RX},	//Fixed (added) SF 2020-03-25
-	{.pad = 4, .funcsel = AM_HAL_PIN_4_UART1RX},	//Fixed (added) SF 2020-03-25
+    {.pad = 2, .funcsel = AM_HAL_PIN_2_UART1RX},
+	{.pad = 4, .funcsel = AM_HAL_PIN_4_UART1RX},
 	{.pad = 9, .funcsel = AM_HAL_PIN_9_UART1RX},
     {.pad = 13, .funcsel = AM_HAL_PIN_13_UART1RX},
     {.pad = 15, .funcsel = AM_HAL_PIN_15_UART1RX},