nrfx 1.7.2 release

NordicSemiconductor · Jul 25, 2019 · 13a7de7 · 13a7de7
1 parent db295c1
commit 13a7de7
Show file tree

Hide file tree

Showing 19 changed files with 424 additions and 182 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,26 @@
 # 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.

diff --git a/drivers/include/nrfx_qspi.h b/drivers/include/nrfx_qspi.h
@@ -155,7 +155,8 @@ void nrfx_qspi_uninit(void);
  * @retval NRFX_SUCCESS            The operation was successful (blocking mode) or operation
  *                                 was commissioned (handler mode).
  * @retval NRFX_ERROR_BUSY         The driver currently handles another operation.
- * @retval NRFX_ERROR_INVALID_ADDR The provided buffer is not placed in the Data RAM region.
+ * @retval NRFX_ERROR_INVALID_ADDR The provided buffer is not placed in the Data RAM region
+ *                                 or its address is not aligned to a 32-bit word.
  */
 nrfx_err_t nrfx_qspi_read(void *   p_rx_buffer,
                           size_t   rx_buffer_length,
@@ -182,7 +183,8 @@ nrfx_err_t nrfx_qspi_read(void *   p_rx_buffer,
  * @retval NRFX_SUCCESS            The operation was successful (blocking mode) or operation
  *                                 was commissioned (handler mode).
  * @retval NRFX_ERROR_BUSY         The driver currently handles other operation.
- * @retval NRFX_ERROR_INVALID_ADDR The provided buffer is not placed in the Data RAM region.
+ * @retval NRFX_ERROR_INVALID_ADDR The provided buffer is not placed in the Data RAM region
+ *                                 or its address is not aligned to a 32-bit word.
  */
 nrfx_err_t nrfx_qspi_write(void const * p_tx_buffer,
                            size_t       tx_buffer_length,
@@ -206,9 +208,10 @@ nrfx_err_t nrfx_qspi_write(void const * p_tx_buffer,
  * @param[in] start_address Memory address to start erasing. If chip erase is performed, address
  *                          field is ommited.
  *
- * @retval NRFX_SUCCESS    The operation was successful (blocking mode) or operation
- *                         was commissioned (handler mode).
- * @retval NRFX_ERROR_BUSY The driver currently handles another operation.
+ * @retval NRFX_SUCCESS            The operation was successful (blocking mode) or operation
+ *                                 was commissioned (handler mode).
+ * @retval NRFX_ERROR_INVALID_ADDR The provided start address is not aligned to a 32-bit word.
+ * @retval NRFX_ERROR_BUSY         The driver currently handles another operation.
  */
 nrfx_err_t nrfx_qspi_erase(nrf_qspi_erase_len_t length,
                            uint32_t             start_address);

diff --git a/drivers/include/nrfx_twi.h b/drivers/include/nrfx_twi.h
@@ -98,6 +98,8 @@ typedef struct
 #define NRFX_TWI_FLAG_NO_XFER_EVT_HANDLER (1UL << 2)
 /** @brief Flag indicating that the TX transfer will not end with a stop condition. */
 #define NRFX_TWI_FLAG_TX_NO_STOP          (1UL << 5)
+/** @brief Flag indicating that the transfer will be suspended. */
+#define NRFX_TWI_FLAG_SUSPEND             (1UL << 6)
 
 /** @brief TWI master driver event types. */
 typedef enum
@@ -131,45 +133,45 @@ typedef struct
 /** @brief Macro for setting the TX transfer descriptor. */
 #define NRFX_TWI_XFER_DESC_TX(addr, p_data, length) \
 {                                                   \
-    .type = NRFX_TWI_XFER_TX,                       \
-    .address = addr,                                \
-    .primary_length = length,                       \
+    .type             = NRFX_TWI_XFER_TX,           \
+    .address          = (addr),                     \
+    .primary_length   = (length),                   \
     .secondary_length = 0,                          \
-    .p_primary_buf  = p_data,                       \
+    .p_primary_buf    = (p_data),                   \
     .p_secondary_buf  = NULL,                       \
 }
 
 /** @brief Macro for setting the RX transfer descriptor. */
 #define NRFX_TWI_XFER_DESC_RX(addr, p_data, length) \
 {                                                   \
-    .type = NRFX_TWI_XFER_RX,                       \
-    .address = addr,                                \
-    .primary_length = length,                       \
+    .type             = NRFX_TWI_XFER_RX,           \
+    .address          = (addr),                     \
+    .primary_length   = (length),                   \
     .secondary_length = 0,                          \
-    .p_primary_buf  = p_data,                       \
+    .p_primary_buf    = (p_data),                   \
     .p_secondary_buf  = NULL,                       \
 }
 
 /** @brief Macro for setting the TX-RX transfer descriptor. */
 #define NRFX_TWI_XFER_DESC_TXRX(addr, p_tx, tx_len, p_rx, rx_len) \
 {                                                                 \
-    .type = NRFX_TWI_XFER_TXRX,                                   \
-    .address = addr,                                              \
-    .primary_length   = tx_len,                                   \
-    .secondary_length = rx_len,                                   \
-    .p_primary_buf    = p_tx,                                     \
-    .p_secondary_buf  = p_rx,                                     \
+    .type             = NRFX_TWI_XFER_TXRX,                       \
+    .address          = (addr),                                   \
+    .primary_length   = (tx_len),                                 \
+    .secondary_length = (rx_len),                                 \
+    .p_primary_buf    = (p_tx),                                   \
+    .p_secondary_buf  = (p_rx),                                   \
 }
 
 /** @brief Macro for setting the TX-TX transfer descriptor. */
 #define NRFX_TWI_XFER_DESC_TXTX(addr, p_tx, tx_len, p_tx2, tx_len2) \
 {                                                                   \
-    .type = NRFX_TWI_XFER_TXTX,                                     \
-    .address = addr,                                                \
-    .primary_length   = tx_len,                                     \
-    .secondary_length = tx_len2,                                    \
-    .p_primary_buf    = p_tx,                                       \
-    .p_secondary_buf  = p_tx2,                                      \
+    .type             = NRFX_TWI_XFER_TXTX,                         \
+    .address          = (addr),                                     \
+    .primary_length   = (tx_len),                                   \
+    .secondary_length = (tx_len2),                                  \
+    .p_primary_buf    = (p_tx),                                     \
+    .p_secondary_buf  = (p_tx2),                                    \
 }
 
 /** @brief Structure for a TWI event. */
@@ -230,6 +232,8 @@ void nrfx_twi_disable(nrfx_twi_t const * p_instance);
  * The transmission will be stopped when an error occurs. If a transfer is ongoing,
  * the function returns the error code @ref NRFX_ERROR_BUSY.
  *
+ * @note This function is deprecated. Use @ref nrfx_twi_xfer instead.
+ *
  * @param[in] p_instance Pointer to the driver instance structure.
  * @param[in] address    Address of a specific slave device (only 7 LSB).
  * @param[in] p_data     Pointer to a transmit buffer.
@@ -241,8 +245,11 @@ void nrfx_twi_disable(nrfx_twi_t const * p_instance);
  * @retval NRFX_SUCCESS                 The procedure is successful.
  * @retval NRFX_ERROR_BUSY              The driver is not ready for a new transfer.
  * @retval NRFX_ERROR_INTERNAL          An error is detected by hardware.
- * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK NACK is received after sending the address in polling mode.
- * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK NACK is received after sending a data byte in polling mode.
+ * @retval NRFX_ERROR_INVALID_STATE     RX transaction is suspended on bus.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK Negative acknowledgement (NACK) is received after sending
+ *                                      the address in polling mode.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK Negative acknowledgement (NACK) is received after sending
+ *                                      a data byte in polling mode.
  */
 nrfx_err_t nrfx_twi_tx(nrfx_twi_t const * p_instance,
                        uint8_t            address,
@@ -256,6 +263,8 @@ nrfx_err_t nrfx_twi_tx(nrfx_twi_t const * p_instance,
  * The transmission will be stopped when an error occurs. If a transfer is ongoing,
  * the function returns the error code @ref NRFX_ERROR_BUSY.
  *
+ * @note This function is deprecated. Use @ref nrfx_twi_xfer instead.
+ *
  * @param[in] p_instance Pointer to the driver instance structure.
  * @param[in] address    Address of a specific slave device (only 7 LSB).
  * @param[in] p_data     Pointer to a receive buffer.
@@ -264,17 +273,21 @@ nrfx_err_t nrfx_twi_tx(nrfx_twi_t const * p_instance,
  * @retval NRFX_SUCCESS                   The procedure is successful.
  * @retval NRFX_ERROR_BUSY                The driver is not ready for a new transfer.
  * @retval NRFX_ERROR_INTERNAL            An error is detected by hardware.
+ * @retval NRFX_ERROR_INVALID_STATE       TX transaction is suspended on bus.
  * @retval NRFX_ERROR_DRV_TWI_ERR_OVERRUN The unread data is replaced by new data.
- * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK   NACK is received after sending the address in polling mode.
- * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK   NACK is received after sending a data byte in polling mode.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK   Negative acknowledgement (NACK) is received after sending
+ *                                        the address in polling mode.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK   Negative acknowledgement (NACK) is received after sending
+ *                                        a data byte in polling mode.
  */
 nrfx_err_t nrfx_twi_rx(nrfx_twi_t const * p_instance,
                        uint8_t            address,
                        uint8_t *          p_data,
                        size_t             length);
 
+
 /**
- * @brief Function for preparing a TWI transfer.
+ * @brief Function for performing a TWI transfer.
  *
  * The following transfer types can be configured (@ref nrfx_twi_xfer_desc_t::type):
  * - @ref NRFX_TWI_XFER_TXRX - Write operation followed by a read operation (without STOP condition in between).
@@ -287,6 +300,8 @@ nrfx_err_t nrfx_twi_rx(nrfx_twi_t const * p_instance,
  * Additional options are provided using the flags parameter:
  * - @ref NRFX_TWI_FLAG_NO_XFER_EVT_HANDLER - No user event handler after transfer completion. In most cases, this also means no interrupt at the end of the transfer.
  * - @ref NRFX_TWI_FLAG_TX_NO_STOP - No stop condition after TX transfer.
+ * - @ref NRFX_TWI_FLAG_SUSPEND - Transfer will be suspended. This allows for combining multiple transfers into one transaction.
+ *                                Only transactions with the same direction can be combined. To finish the transaction, call the function without this flag.
  *
  * @note
  * Some flag combinations are invalid:
@@ -300,9 +315,12 @@ nrfx_err_t nrfx_twi_rx(nrfx_twi_t const * p_instance,
  * @retval NRFX_ERROR_BUSY                The driver is not ready for a new transfer.
  * @retval NRFX_ERROR_NOT_SUPPORTED       The provided parameters are not supported.
  * @retval NRFX_ERROR_INTERNAL            An error is detected by hardware.
+ * @retval NRFX_ERROR_INVALID_STATE       Other direction of transaction is suspended on the bus.
  * @retval NRFX_ERROR_DRV_TWI_ERR_OVERRUN The unread data is replaced by new data (TXRX and RX)
- * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK   NACK is received after sending the address.
- * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK   NACK is received after sending a data byte.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_ANACK   Negative acknowledgement (NACK) is received after sending
+ *                                        the address in polling mode.
+ * @retval NRFX_ERROR_DRV_TWI_ERR_DNACK   Negative acknowledgement (NACK) is received after sending
+ *                                        a data byte in polling mode.
  */
 nrfx_err_t nrfx_twi_xfer(nrfx_twi_t           const * p_instance,
                          nrfx_twi_xfer_desc_t const * p_xfer_desc,

diff --git a/drivers/include/nrfx_twim.h b/drivers/include/nrfx_twim.h
@@ -144,44 +144,44 @@ typedef struct
 #define NRFX_TWIM_XFER_DESC_TX(addr, p_data, length) \
 {                                                    \
     .type             = NRFX_TWIM_XFER_TX,           \
-    .address          = addr,                        \
-    .primary_length   = length,                      \
+    .address          = (addr),                      \
+    .primary_length   = (length),                    \
     .secondary_length = 0,                           \
-    .p_primary_buf    = p_data,                      \
+    .p_primary_buf    = (p_data),                    \
     .p_secondary_buf  = NULL,                        \
 }
 
 /** @brief Macro for setting the RX transfer descriptor. */
 #define NRFX_TWIM_XFER_DESC_RX(addr, p_data, length) \
 {                                                    \
     .type             = NRFX_TWIM_XFER_RX,           \
-    .address          = addr,                        \
-    .primary_length   = length,                      \
+    .address          = (addr),                      \
+    .primary_length   = (length),                    \
     .secondary_length = 0,                           \
-    .p_primary_buf    = p_data,                      \
+    .p_primary_buf    = (p_data),                    \
     .p_secondary_buf  = NULL,                        \
 }
 
 /** @brief Macro for setting the TX-RX transfer descriptor. */
 #define NRFX_TWIM_XFER_DESC_TXRX(addr, p_tx, tx_len, p_rx, rx_len) \
 {                                                                  \
     .type             = NRFX_TWIM_XFER_TXRX,                       \
-    .address          = addr,                                      \
-    .primary_length   = tx_len,                                    \
-    .secondary_length = rx_len,                                    \
-    .p_primary_buf    = p_tx,                                      \
-    .p_secondary_buf  = p_rx,                                      \
+    .address          = (addr),                                    \
+    .primary_length   = (tx_len),                                  \
+    .secondary_length = (rx_len),                                  \
+    .p_primary_buf    = (p_tx),                                    \
+    .p_secondary_buf  = (p_rx),                                    \
 }
 
 /** @brief Macro for setting the TX-TX transfer descriptor. */
 #define NRFX_TWIM_XFER_DESC_TXTX(addr, p_tx, tx_len, p_tx2, tx_len2) \
 {                                                                    \
     .type             = NRFX_TWIM_XFER_TXTX,                         \
-    .address          = addr,                                        \
-    .primary_length   = tx_len,                                      \
-    .secondary_length = tx_len2,                                     \
-    .p_primary_buf    = p_tx,                                        \
-    .p_secondary_buf  = p_tx2,                                       \
+    .address          = (addr),                                      \
+    .primary_length   = (tx_len),                                    \
+    .secondary_length = (tx_len2),                                   \
+    .p_primary_buf    = (p_tx),                                      \
+    .p_secondary_buf  = (p_tx2),                                     \
 }
 
 /** @brief Structure for a TWI event. */
@@ -242,6 +242,8 @@ void nrfx_twim_disable(nrfx_twim_t const * p_instance);
  * The transmission will be stopped when an error occurs. If a transfer is ongoing,
  * the function returns the error code @ref NRFX_ERROR_BUSY.
  *
+ * @note This function is deprecated. Use @ref nrfx_twim_xfer instead.
+ *
  * @note Peripherals using EasyDMA (including TWIM) require the transfer buffers
  *       to be placed in the Data RAM region. If this condition is not met,
  *       this function fails with the error code NRFX_ERROR_INVALID_ADDR.
@@ -276,6 +278,8 @@ nrfx_err_t nrfx_twim_tx(nrfx_twim_t const * p_instance,
  * The transmission will be stopped when an error occurs. If a transfer is ongoing,
  * the function returns the error code @ref NRFX_ERROR_BUSY.
  *
+ * @note This function is deprecated. Use @ref nrfx_twim_xfer instead.
+ *
  * @param[in] p_instance Pointer to the driver instance structure.
  * @param[in] address    Address of a specific slave device (only 7 LSB).
  * @param[in] p_data     Pointer to a receive buffer.
@@ -296,7 +300,7 @@ nrfx_err_t nrfx_twim_rx(nrfx_twim_t const * p_instance,
                         size_t              length);
 
 /**
- * @brief Function for preparing a TWI transfer.
+ * @brief Function for performing a TWI transfer.
  *
  * The following transfer types can be configured (@ref nrfx_twim_xfer_desc_t::type):
  * - @ref NRFX_TWIM_XFER_TXRX - Write operation followed by a read operation (without STOP condition in between).

diff --git a/drivers/nrfx_common.h b/drivers/nrfx_common.h
@@ -136,6 +136,17 @@ extern "C" {
  */
 #define NRFX_ARRAY_SIZE(array) (sizeof(array) / sizeof((array)[0]))
 
+/**
+ * @brief Macro for getting the offset (in bytes) from the beginning of a structure
+ *        of the specified type to its specified member.
+ *
+ * @param[in] type   Structure type.
+ * @param[in] member Structure member whose offset is searched for.
+ *
+ * @return Member offset in bytes.
+ */
+#define NRFX_OFFSETOF(type, member)  ((size_t)&(((type *)0)->member))
+
 /**@brief Macro for checking if given lengths of EasyDMA transfers do not exceed
  *        the limit of the specified peripheral.
  *