Apollo3: Implement AnalogIn and PwmOut (#476)

* Apollo3: Implement ADC

* Start implementing PWM

* Map all PWM pins

* Initial pwmout_period implementation

* Finish PWM driver, start getting PWM and ADC working

* PWM passing tests!

* Oops remove debug prints

* A few fixes

Author: multiplemonomials

cmsis/device/rtos/include/mbed_boot.h

@@ -19,6 +19,8 @@
 
 #include "mbed_toolchain.h"
 
+#include <stdint.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif

hal/include/hal/pwmout_api.h

@@ -42,7 +42,7 @@ typedef struct pwmout_s pwmout_t;
  * * ::pwmout_write sets the output duty-cycle in range <0.0f, 1.0f>
  * * ::pwmout_read returns the current float-point output duty-cycle in range <0.0f, 1.0f>
  * * ::pwmout_period sets the PWM period specified in seconds, keeping the duty cycle the same
- * * ::pwmout_period_ms sets the PWM period specified in miliseconds, keeping the duty cycle the same
+ * * ::pwmout_period_ms sets the PWM period specified in milliseconds, keeping the duty cycle the same
  * * ::pwmout_period_us sets the PWM period specified in microseconds, keeping the duty cycle the same
  * * ::pwmout_read_period_us reads the PWM period specified in microseconds
  * * ::pwmout_pulsewidth sets the PWM pulsewidth specified in seconds, keeping the period the same
@@ -84,7 +84,11 @@ void pwmout_init_direct(pwmout_t *obj, const PinMap *pinmap);
  */
 void pwmout_init(pwmout_t *obj, PinName pin);
 
-/** Deinitialize the pwmout object
+/**
+ * @brief Deinitialize the pwmout object
+ *
+ * After this function is called, the PWM output must stop generating edges.
+ * The logic level is not specified -- it may be left high, low, or tristated.
  *
  * @param obj The pwmout object
  */

hal/include/hal/spi_api.h

@@ -276,11 +276,15 @@ int  spi_master_write(spi_t *obj, int value);
  *
  *  The total number of bytes sent and received will be the maximum of
  *  tx_length and rx_length. The bytes written will be padded with the
- *  value 0xff.
+ *  write fill value.
  *
  * Note: Even if the word size / bits per frame is not 8, \c rx_length and \c tx_length
  * still give lengths in bytes of input data, not numbers of words.
  *
+ * Note: If \c tx_rx_buffers_equal_length is true in the capabilities structure, then either \c rx_length and \c tx_length
+ * must be the same, or one of them will be zero. If this is not the case than the HAL implementation should
+ * return an error.
+ *
  * @param[in] obj        The SPI peripheral to use for sending
  * @param[in] tx_buffer  Pointer to the byte-array of data to write to the device
  * @param[in] tx_length  Number of bytes to write, may be zero
@@ -432,7 +436,7 @@ const PinMap *spi_slave_cs_pinmap(void);
  * @note On MCUs with a data cache, the return value is used to determine if a cache invalidation needs to be done
  * after the transfer is complete.  If this function returns true, the driver layer will cache invalidate the Rx buffer under
  * the assumption that the data needs to be re-read from main memory.  Be careful, because if the read was not actually
- * done by DMA, and the rx data is in the CPU cache, this invalidation will corrupt it.
+ * done by DMA, and the rx data is in the CPU cache and NOT main memory, this invalidation will corrupt it.
  *
  * @note The application layer will always acquire the SPI peripheral first before calling this, including setting the frequency and the bit width. So,
  *     the \c bit_width argument will never be different from the SPI's currently set bit width, and can actually be ignored.

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/CMakeLists.txt

@@ -50,6 +50,9 @@ target_sources(mbed-apollo3
         device/spi_api.c
         device/us_ticker.c
         device/itm_api.c
+        device/analogin_api.c
+        device/pwmout_api.c
+        device/mbed_overrides.c
 
         sdk/CMSIS/AmbiqMicro/Source/system_apollo3.c
 

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS/PinNames.h

@@ -128,6 +128,9 @@ typedef enum
     SERIAL1_TX = IO_24,
     SERIAL1_RX = IO_25,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;
@@ -140,11 +143,6 @@ typedef enum
 #define QWIIC_SCL I2C_SCL
 #define QWIIC_SDA I2C_SDA
 
-// SPI bus
-#define SPI_SCLK IO_5
-#define SPI_MOSI IO_7
-#define SPI_MISO IO_6
-
 #if defined(MBED_CONF_TARGET_STDIO_UART_TX)
 #define STDIO_UART_TX MBED_CONF_TARGET_STDIO_UART_TX
 #else

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS_ATP/PinNames.h

@@ -164,6 +164,9 @@ typedef enum
     SERIAL1_TX = D24,
     SERIAL1_RX = D25,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS_DK/PinNames.h

@@ -134,6 +134,9 @@ typedef enum
     CONSOLE_TX = SERIAL_TX,
     CONSOLE_RX = SERIAL_RX,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS_MODULE/PinNames.h

@@ -97,6 +97,9 @@ typedef enum
     CONSOLE_TX = SERIAL_TX,
     CONSOLE_RX = SERIAL_RX,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS_NANO/PinNames.h

@@ -130,6 +130,9 @@ typedef enum
     SERIAL1_TX = D9,
     SERIAL1_RX = D10,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;

targets/TARGET_Ambiq_Micro/TARGET_Apollo3/TARGET_SFE_ARTEMIS_THING_PLUS/PinNames.h

@@ -137,6 +137,9 @@ typedef enum
     SERIAL1_TX = D1,
     SERIAL1_RX = D0,
 
+    // Not a real pin on the device, but can be passed to AnalogIn to read the internal temperature sensor
+    INT_TEMP_SENSOR = 0x10000,
+
     // Not connected
     NC = NC_VAL
 } PinName;