Merge pull request #360 from adafruit/spi-dma

use SPIM3 for nrf52840 with maximum speed at 32 Mhz

Author: hathach

cores/nRF5/nordic/nrfx/CHANGELOG.md

@@ -1,6 +1,50 @@
 # Changelog
 All notable changes to this project are documented in this file.
 
+## [1.7.2] - 2019-07-25
+### Added
+- Added functions in the DPPI, GPIOTE, PPI, RTC, and TIMER HALs for getting tasks and events specified by index.
+- Added the possibility of suspending transfers in the TWI driver. This allows combining several transfers into one continuous TWI transaction.
+- Added termination of transfers at deinitialization of the UARTE driver.
+- Added buffer alignment checks in the QSPI driver.
+- Introduced the NRFX_OFFSETOF macro that duplicates the functionality of the built-in offsetof() mechanism, but can be used without issues also with non-constant expressions.
+- Added an alternative way of ending the DMA transfer loop in the USBD driver.
+- Added the CTSTARTED and CTSTOPPED events to the CLOCK HAL.
+
+### Changed
+- Removed an assertion that prevented setting the data payload size of isochronous endpoints to zero, to fulfill requirements of the USB 2.0 specification, paragraph 5.6.3.
+- Declared the tx_buffer_length field in the UART driver's control block as volatile to prevent issues in case of compilation with high optimization level.
+
+### Fixed
+- Fixed an incorrect conversion of frequency values in the RADIO HAL.
+- Fixed an incorrectly enabled interrupt in the QSPI driver.
+- Corrected the LFCLK source selection values in the template configuration file for nRF9160.
+- Fixed support for external LFCLK sources for nRF52811.
+
+## [1.7.1] - 2019-04-08
+### Added
+- Added functions in the NVMC driver for getting the flash page size, the count of pages and the total flash size.
+
+### Fixed
+- Fixed handling of short unaligned write requests (1 or 2 bytes in length) in the nrfx_nvmc_bytes_write() function.
+
+## [1.7.0] - 2019-03-29
+### Added
+- Added drivers for NVMC and TEMP.
+- Added HALs: AAR and FICR.
+- Added support for the custom instruction long frame mode in the QSPI driver.
+
+### Changed
+- Reworked HAL for NVMC. Now it can be used for all SoCs supported by nrfx.
+- Reworked HAL for TEMP.
+- Improved documentation. Now it is more precise and can be generated without warnings with newer versions of doxygen.
+- Improved the UARTE driver to consume less current after the TX operation. Now at the end of the transmission the transmitter is turned off by the STOPTX task.
+- Improved C++ support in drivers. Now fields in structures are filled up in the correct order.
+- Changed to size_t the type used for holding the amount of data in the TWIS driver.
+
+### Fixed
+- Fixed a race condition in the USBD driver. It could occur when an IN transfer was interrupted by an OUT transaction, which in turn was interrupted by a process with a higher priority.
+
 ## [1.6.2] - 2019-02-12
 ### Added
 - Added the possibility to use the macro NRFX_COREDEP_DELAY_US_LOOP_CYCLES to specify the number of cycles consumed by one iteration of the internal loop in the function nrfx_coredep_delay_us().

cores/nRF5/nordic/nrfx/drivers/include/nrf_bitmask.h

@@ -45,14 +45,17 @@ extern "C" {
  * @brief   Bitmask managing module.
  */
 
+/** @brief Macro for getting index of byte in byte stream where @c abs_bit is put. */
 #define BITMASK_BYTE_GET(abs_bit) ((abs_bit)/8)
+
+/** @brief Macro for getting relative index of bit in byte. */
 #define BITMASK_RELBIT_GET(abs_bit) ((abs_bit) & 0x00000007)
 
 /**
- * Function for checking if bit in the multi-byte bit mask is set.
+ * @brief Function for checking if bit in the multi-byte bit mask is set.
  *
- * @param bit    Bit index.
- * @param p_mask A pointer to mask with bit fields.
+ * @param[in] bit    Bit index.
+ * @param[in] p_mask Pointer to mask with bit fields.
  *
  * @return 0 if bit is not set, positive value otherwise.
  */
@@ -65,10 +68,10 @@ __STATIC_INLINE uint32_t nrf_bitmask_bit_is_set(uint32_t bit, void const * p_mas
 }
 
 /**
- * Function for setting a bit in the multi-byte bit mask.
+ * @brief Function for setting a bit in the multi-byte bit mask.
  *
- * @param bit    Bit index.
- * @param p_mask A pointer to mask with bit fields.
+ * @param[in] bit    Bit index.
+ * @param[in] p_mask Pointer to mask with bit fields.
  */
 __STATIC_INLINE void nrf_bitmask_bit_set(uint32_t bit, void * p_mask)
 {
@@ -79,10 +82,10 @@ __STATIC_INLINE void nrf_bitmask_bit_set(uint32_t bit, void * p_mask)
 }
 
 /**
- * Function for clearing a bit in the multi-byte bit mask.
+ * @brief Function for clearing a bit in the multi-byte bit mask.
  *
- * @param bit    Bit index.
- * @param p_mask A pointer to mask with bit fields.
+ * @param[in] bit    Bit index.
+ * @param[in] p_mask Pointer to mask with bit fields.
  */
 __STATIC_INLINE void nrf_bitmask_bit_clear(uint32_t bit, void * p_mask)
 {
@@ -93,12 +96,12 @@ __STATIC_INLINE void nrf_bitmask_bit_clear(uint32_t bit, void * p_mask)
 }
 
 /**
- * Function for performing bitwise OR operation on two multi-byte bit masks.
+ * @brief Function for performing bitwise OR operation on two multi-byte bit masks.
  *
- * @param p_mask1    A pointer to the first bit mask.
- * @param p_mask2    A pointer to the second bit mask.
- * @param p_out_mask A pointer to the output bit mask.
- * @param length     Length of output mask in bytes.
+ * @param[in] p_mask1    Pointer to the first bit mask.
+ * @param[in] p_mask2    Pointer to the second bit mask.
+ * @param[in] p_out_mask Pointer to the output bit mask.
+ * @param[in] length     Length of output mask in bytes.
  */
 __STATIC_INLINE void nrf_bitmask_masks_or(void const *   p_mask1,
                                           void const *   p_mask2,
@@ -116,12 +119,12 @@ __STATIC_INLINE void nrf_bitmask_masks_or(void const *   p_mask1,
 }
 
 /**
- * Function for performing bitwise AND operation on two multi-byte bit masks.
+ * @brief Function for performing bitwise AND operation on two multi-byte bit masks.
  *
- * @param p_mask1    A pointer to the first bit mask.
- * @param p_mask2    A pointer to the second bit mask.
- * @param p_out_mask A pointer to the output bit mask.
- * @param length     Length of output mask in bytes.
+ * @param[in] p_mask1    Pointer to the first bit mask.
+ * @param[in] p_mask2    Pointer to the second bit mask.
+ * @param[in] p_out_mask Pointer to the output bit mask.
+ * @param[in] length     Length of output mask in bytes.
  */
 __STATIC_INLINE void nrf_bitmask_masks_and(void const *   p_mask1,
                                            void const *   p_mask2,

cores/nRF5/nordic/nrfx/drivers/include/nrfx_adc.h

@@ -46,46 +46,38 @@ extern "C" {
  * @brief   Analog-to-Digital Converter (ADC) peripheral driver.
  */
 
-/**
- * @brief Driver event types.
- */
+/** @brief Driver event types. */
 typedef enum
 {
     NRFX_ADC_EVT_DONE,    ///< Event generated when the buffer is filled with samples.
     NRFX_ADC_EVT_SAMPLE,  ///< Event generated when the requested channel is sampled.
 } nrfx_adc_evt_type_t;
 
-/**
- * @brief Analog-to-digital converter driver DONE event.
- */
+/** @brief ADC driver DONE event structure. */
 typedef struct
 {
     nrf_adc_value_t * p_buffer; ///< Pointer to the buffer with converted samples.
     uint16_t          size;     ///< Number of samples in the buffer.
 } nrfx_adc_done_evt_t;
 
-/**
- * @brief Analog-to-digital converter driver SAMPLE event.
- */
+/** @brief SAMPLE event structure. */
 typedef struct
 {
     nrf_adc_value_t   sample; ///< Converted sample.
 } nrfx_adc_sample_evt_t;
 
-/**
- * @brief Analog-to-digital converter driver event.
- */
+/** @brief ADC driver event. */
 typedef struct
 {
     nrfx_adc_evt_type_t type;  ///< Event type.
     union
     {
         nrfx_adc_done_evt_t   done;   ///< Data for DONE event.
         nrfx_adc_sample_evt_t sample; ///< Data for SAMPLE event.
-    } data;
+    } data;                           ///< Union to store event data.
 } nrfx_adc_evt_t;
 
-/**@brief Macro for initializing the ADC channel with the default configuration. */
+/** @brief Macro for initializing the ADC channel with the default configuration. */
 #define NRFX_ADC_DEFAULT_CHANNEL(analog_input)                 \
  {                                                             \
      NULL,                                                     \
@@ -98,7 +90,7 @@ typedef struct
      }                                                         \
  }
 
-// Forward declaration of the nrfx_adc_channel_t type.
+/** @brief Forward declaration of the nrfx_adc_channel_t type. */
 typedef struct nrfx_adc_channel_s nrfx_adc_channel_t;
 
 /**
@@ -113,9 +105,7 @@ struct nrfx_adc_channel_s
     nrf_adc_config_t     config; ///< ADC configuration for the current channel.
 };
 
-/**
- * @brief ADC configuration.
- */
+/** @brief ADC configuration. */
 typedef struct
 {
     uint8_t interrupt_priority; ///< Priority of ADC interrupt.
@@ -142,11 +132,11 @@ typedef void (*nrfx_adc_event_handler_t)(nrfx_adc_evt_t const * p_event);
  * If a valid event handler is provided, the driver is initialized in non-blocking mode.
  * If event_handler is NULL, the driver works in blocking mode.
  *
- * @param[in] p_config      Pointer to the structure with initial configuration.
+ * @param[in] p_config      Pointer to the structure with the initial configuration.
  * @param[in] event_handler Event handler provided by the user.
  *
- * @retval    NRFX_SUCCESS If initialization was successful.
- * @retval    NRFX_ERROR_INVALID_STATE If the driver is already initialized.
+ * @retval NRFX_SUCCESS             Initialization was successful.
+ * @retval NRFX_ERROR_INVALID_STATE The driver is already initialized.
  */
 nrfx_err_t nrfx_adc_init(nrfx_adc_config_t const * p_config,
                          nrfx_adc_event_handler_t  event_handler);
@@ -169,6 +159,8 @@ void nrfx_adc_uninit(void);
  *
  * @note The channel instance variable @p p_channel is used by the driver as an item
  *       in a list. Therefore, it cannot be an automatic variable that is located on the stack.
+ *
+ * @param[in] p_channel Pointer to the channel instance.
  */
 void nrfx_adc_channel_enable(nrfx_adc_channel_t * const p_channel);
 
@@ -177,6 +169,8 @@ void nrfx_adc_channel_enable(nrfx_adc_channel_t * const p_channel);
  *
  * This function can be called only when there is no conversion in progress
  * (the ADC is not busy).
+ *
+ * @param p_channel Pointer to the channel instance.
  */
 void nrfx_adc_channel_disable(nrfx_adc_channel_t * const p_channel);
 
@@ -206,11 +200,11 @@ void nrfx_adc_sample(void);
  * fail if ADC is busy. The channel does not need to be enabled to perform a single conversion.
  *
  * @param[in]  p_channel Channel.
- * @param[out] p_value   Pointer to the location where the result should be placed. Unless NULL is
+ * @param[out] p_value   Pointer to the location where the result is to be placed. Unless NULL is
  *                       provided, the function is blocking.
  *
- * @retval NRFX_SUCCESS    If conversion was successful.
- * @retval NRFX_ERROR_BUSY If the ADC driver is busy.
+ * @retval NRFX_SUCCESS    Conversion was successful.
+ * @retval NRFX_ERROR_BUSY The ADC driver is busy.
  */
 nrfx_err_t nrfx_adc_sample_convert(nrfx_adc_channel_t const * const p_channel,
                                    nrf_adc_value_t                * p_value);
@@ -241,16 +235,16 @@ nrfx_err_t nrfx_adc_sample_convert(nrfx_adc_channel_t const * const p_channel,
  * @param[in] buffer Result buffer.
  * @param[in] size   Buffer size in samples.
  *
- * @retval NRFX_SUCCESS    If conversion was successful.
- * @retval NRFX_ERROR_BUSY If the driver is busy.
+ * @retval NRFX_SUCCESS    Conversion was successful.
+ * @retval NRFX_ERROR_BUSY The driver is busy.
  */
 nrfx_err_t nrfx_adc_buffer_convert(nrf_adc_value_t * buffer, uint16_t size);
 
 /**
  * @brief Function for retrieving the ADC state.
  *
- * @retval true  If the ADC is busy.
- * @retval false If the ADC is ready.
+ * @retval true  The ADC is busy.
+ * @retval false The ADC is ready.
  */
 bool nrfx_adc_is_busy(void);
 
@@ -273,11 +267,11 @@ __STATIC_INLINE uint32_t nrfx_adc_start_task_get(void)
 
 #endif
 
+/** @} */
 
-void nrfx_adc_irq_handler(void);
 
+void nrfx_adc_irq_handler(void);
 
-/** @} */
 
 #ifdef __cplusplus
 }