Release v3.0.0

README.md

@@ -2,15 +2,15 @@
 
 Flexible Software Package (FSP) for Renesas RA MCU Family
 
-FSP is the next generation Arm® MCU software package from Renesas, that enables secure devices and IoT connectivity through production ready peripheral drivers, FreeRTOS, and portable middleware stacks.
-FSP includes best-in-class HAL drivers with high performance and low memory footprint. Middleware stacks with FreeRTOS integration are included to ease implementation of complex modules like communication and security.
+FSP is the next generation Arm® MCU software package from Renesas, that enables secure devices and IoT connectivity through production ready peripheral drivers, Azure RTOS or FreeRTOS, and portable middleware stacks.
+FSP includes best-in-class HAL drivers with high performance and low memory footprint. Middleware stacks with Azure RTOS and FreeRTOS integration are included to ease implementation of complex modules like communication and security.
 The e² studio ISDE provides support with intuitive configurators and intelligent code generation to make programming and debugging easier and faster.
 
 FSP uses an open software ecosystem and provides flexibility in using your preferred RTOS, legacy code, and third-party ecosystem solutions.
 
 ### Current Release
 
-[FSP v2.4.0](https://github.com/renesas/fsp/releases/tag/v2.4.0)
+[FSP v3.0.0](https://github.com/renesas/fsp/releases/tag/v3.0.0)
 
 ### Supported RA MCU Kits
 
@@ -42,12 +42,13 @@ FSP uses an open software ecosystem and provides flexibility in using your prefe
 
 - FSP versions of 2.0.0 and later require a minimum e² studio version of 2020-10.
 - FSP versions of 2.3.0 and later require a minimum e² studio version of 2021-01.
+- FSP versions of 3.0.0 and later require a minimum e² studio version of 2021-04.
 
 If you have already installed a previous FSP release that included e² studio then you can download the packs separately. These are available for download under the Assets section for each release. There is a zipped version, FSP_Packs_\<version\>.zip, and an installer version, FSP_Packs_\<version\>.exe.
 
 #### For new users that are using FSP with e² studio
 
-1.	Download the FSP with e² studio Installer from the Assets section of the [current release](https://github.com/renesas/fsp/releases/tag/v2.4.0).
+1.	Download the FSP with e² studio Installer from the Assets section of the [current release](https://github.com/renesas/fsp/releases/tag/v3.0.0).
 2.	Run the installer. This will install the e² studio tool, FSP packs, GCC toolchain and other tools required to use this software. No additional installations are required.
 
 #### If using RA Smart Configurator (RASC) with IAR Embedded Workbench or Keil MDK ####

ra/board/ra6m5_ek/board.h

@@ -45,14 +45,6 @@
  **********************************************************************************************************************/
 #define BOARD_RA6M5_EK
 
-/* Except for BSP_CLOCK_CFG_SUBCLOCK_POPULATED and _MAIN_OSC_POPULATED, these are just default settings, not based on the board design. */
-#define BSP_CLOCK_CFG_MAIN_OSC_POPULATED           (1)
-#define BSP_CLOCK_CFG_MAIN_OSC_WAIT                (9)
-#define BSP_CLOCK_CFG_MAIN_OSC_CLOCK_SOURCE        (0)
-#define BSP_CLOCK_CFG_SUBCLOCK_POPULATED           (1)
-#define BSP_CLOCK_CFG_SUBCLOCK_DRIVE               (0)
-#define BSP_CLOCK_CFG_SUBCLOCK_STABILIZATION_MS    (1000U)
-
 /***********************************************************************************************************************
  * Typedef definitions
  **********************************************************************************************************************/

ra/fsp/inc/api/bsp_api.h

@@ -26,7 +26,7 @@
  **********************************************************************************************************************/
 
 /* FSP Common Includes. */
-#include "../../inc/fsp_common_api.h"
+#include "fsp_common_api.h"
 
 /* Gets MCU configuration information. */
 #include "bsp_cfg.h"

ra/fsp/inc/api/r_adc_api.h

@@ -54,10 +54,6 @@ FSP_HEADER
  * Macro definitions
  **********************************************************************************************************************/
 
-/* Version Number of API.  */
-#define ADC_API_VERSION_MAJOR    (1U)  // DEPRECATED
-#define ADC_API_VERSION_MINOR    (0U)  // DEPRECATED
-
 /*****************************************************************************
  * Typedef definitions
  ******************************************************************************/
@@ -330,16 +326,6 @@ typedef struct st_adc_api
      * @param[out]  p_adc_info   Pointer to ADC information structure
      */
     fsp_err_t (* infoGet)(adc_ctrl_t * const p_ctrl, adc_info_t * const p_adc_info);
-
-    /* DEPRECATED Retrieve the API version.
-     * @par Implemented as
-     * - @ref R_ADC_VersionGet()
-     * - @ref R_SDADC_VersionGet()
-     *
-     * @pre This function retrieves the API version.
-     * @param[in]  p_version   Pointer to version structure
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * const p_version);
 } adc_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_ble_api.h

@@ -50,8 +50,6 @@ FSP_HEADER
 /**********************************************************************************************************************
  * Macro definitions
  **********************************************************************************************************************/
-#define BLE_API_VERSION_MAJOR    (2U)  // DEPRECATED
-#define BLE_API_VERSION_MINOR    (0U)  // DEPRECATED
 
 /* =================================================== Main Macro =================================================== */
 

ra/fsp/inc/api/r_cac_api.h

@@ -49,8 +49,6 @@ FSP_HEADER
 /***********************************************************************************************************************
  * Macro definitions
  **********************************************************************************************************************/
-#define CAC_API_VERSION_MAJOR    (1U)  // DEPRECATED
-#define CAC_API_VERSION_MINOR    (1U)  // DEPRECATED
 
 /***********************************************************************************************************************
  * Typedef definitions
@@ -212,11 +210,6 @@ typedef struct st_cac_api
      * @param[in]  p_ctrl        Pointer to CAC device control.
      */
     fsp_err_t (* close)(cac_ctrl_t * const p_ctrl);
-
-    /* DEPRECATED Get the CAC API and code version information.
-     * @param[out]  p_version is value returned.
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * p_version);
 } cac_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_can_api.h

@@ -54,8 +54,6 @@ FSP_HEADER
 /**********************************************************************************************************************
  * Macro definitions
  **********************************************************************************************************************/
-#define CAN_API_VERSION_MAJOR      (1U) // DEPRECATED
-#define CAN_API_VERSION_MINOR      (1U) // DEPRECATED
 
 #if BSP_FEATURE_CANFD_NUM_CHANNELS
  #define CAN_DATA_BUFFER_LENGTH    (64)
@@ -106,6 +104,7 @@ typedef enum e_can_test_mode
     CAN_TEST_MODE_INTERNAL_BUS      = 0x80 ///< CANFD Internal CAN Bus Communication Test Mode.
 } can_test_mode_t;
 
+/** CAN status info */
 typedef struct st_can_info
 {
     uint32_t status;                   ///< Useful information from the CAN status register.
@@ -123,42 +122,13 @@ typedef enum e_can_id_mode
     CAN_ID_MODE_EXTENDED,              ///< Extended IDs of 29 bits used.
 } can_id_mode_t;
 
-/** Global CAN ID mode settings */
-typedef enum e_can_global_id_mode
-{
-    CAN_GLOBAL_ID_MODE_STANDARD,       ///< Standard IDs of 11 bits used.
-    CAN_GLOBAL_ID_MODE_EXTENDED,       ///< Extended IDs of 29 bits used.
-    CAN_GLOBAL_ID_MODE_MIXED,          ///< Both Standard and Extended IDs used.
-} can_global_id_mode_t;
-
 /** CAN frame types */
 typedef enum e_can_frame_type
 {
     CAN_FRAME_TYPE_DATA,               ///< Data frame.
     CAN_FRAME_TYPE_REMOTE,             ///< Remote frame.
 } can_frame_type_t;
 
-/** CAN Message Modes */
-typedef enum e_can_message_mode
-{
-    CAN_MESSAGE_MODE_OVERWRITE = 0,    ///< Receive data will be overwritten if not read before the next frame.
-    CAN_MESSAGE_MODE_OVERRUN,          ///< Receive data will be retained until it is read.
-} can_message_mode_t;
-
-/** CAN Source Clock */
-typedef enum e_can_clock_source
-{
-    CAN_CLOCK_SOURCE_PCLKB = 0,        ///< PCLKB is the source of the CAN Clock
-    CAN_CLOCK_SOURCE_CANMCLK,          ///< CANMCLK is the source of the CAN Clock
-} can_clock_source_t;
-
-/** CAN Mailbox type */
-typedef enum e_can_mailbox_send_receive
-{
-    CAN_MAILBOX_RECEIVE,               ///< Mailbox is for receiving.
-    CAN_MAILBOX_TRANSMIT,              ///< Mailbox is for sending.
-} can_mailbox_send_receive_t;
-
 /** CAN bit rate configuration. */
 typedef struct st_can_bit_timing_cfg
 {
@@ -168,9 +138,6 @@ typedef struct st_can_bit_timing_cfg
     uint32_t synchronization_jump_width; ///< Synchronization jump width.
 } can_bit_timing_cfg_t;
 
-/* DEPRECATED CAN Id */
-typedef uint32_t can_id_t;
-
 /** CAN data Frame */
 typedef struct st_can_frame
 {
@@ -198,15 +165,6 @@ typedef struct st_can_callback_args
     can_frame_t   frame;               ///< Received frame data.
 } can_callback_args_t;
 
-/** CAN Mailbox */
-typedef struct st_can_mailbox
-{
-    uint32_t                   mailbox_id;   ///< Mailbox ID.
-    can_id_mode_t              id_mode;      ///< Standard or Extended ID. Only used in Mixed ID mode.
-    can_mailbox_send_receive_t mailbox_type; ///< Receive or Transmit mailbox type.
-    can_frame_type_t           frame_type;   ///< Frame type for receive mailbox.
-} can_mailbox_t;
-
 /** CAN Configuration */
 typedef struct st_can_cfg
 {
@@ -219,15 +177,11 @@ typedef struct st_can_cfg
     void const * p_context;                            ///< User defined callback context.
 
     /* Pointer to CAN peripheral specific configuration */
-    void const         * p_extend;                     ///< CAN hardware dependent configuration
-    uint8_t              ipl;                          ///< Error/Transmit/Receive interrupt priority
-    IRQn_Type            error_irq;                    ///< Error IRQ number
-    IRQn_Type            mailbox_rx_irq;               ///< Receive IRQ number
-    IRQn_Type            mailbox_tx_irq;               ///< Transmit IRQ number
-    can_mailbox_t      * p_mailbox;                    ///< Pointer to mailboxes.
-    can_global_id_mode_t id_mode;                      ///< Standard or Extended ID mode.
-    uint32_t             mailbox_count;                ///< Number of mailboxes.
-    can_message_mode_t   message_mode;                 ///< Overwrite message or overrun.
+    void const * p_extend;                             ///< CAN hardware dependent configuration
+    uint8_t      ipl;                                  ///< Error/Transmit/Receive interrupt priority
+    IRQn_Type    error_irq;                            ///< Error IRQ number
+    IRQn_Type    rx_irq;                               ///< Receive IRQ number
+    IRQn_Type    tx_irq;                               ///< Transmit IRQ number
 } can_cfg_t;
 
 /** CAN control block.  Allocate an instance specific control block to pass into the CAN API calls.
@@ -311,14 +265,6 @@ typedef struct st_can_api
      */
     fsp_err_t (* callbackSet)(can_ctrl_t * const p_api_ctrl, void (* p_callback)(can_callback_args_t *),
                               void const * const p_context, can_callback_args_t * const p_callback_memory);
-
-    /* DEPRECATED Version get function for CAN device
-     * @par Implemented as
-     * - R_CAN_VersionGet()
-     * - R_CANFD_VersionGet()
-     * @param[in]   p_version  Pointer to the memory to store the version information
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * const p_version);
 } can_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_cgc_api.h

@@ -56,10 +56,6 @@ FSP_HEADER
  * Macro definitions
  **********************************************************************************************************************/
 
-/* Version Number of API. */
-#define CGC_API_VERSION_MAJOR    (1U)  // DEPRECATED
-#define CGC_API_VERSION_MINOR    (1U)  // DEPRECATED
-
 /**********************************************************************************************************************
  * Typedef definitions
  **********************************************************************************************************************/
@@ -347,13 +343,6 @@ typedef struct
      * @param[in]   p_ctrl          Pointer to instance control block
      */
     fsp_err_t (* close)(cgc_ctrl_t * const p_ctrl);
-
-    /* DEPRECATED Gets the CGC driver version.
-     * @par Implemented as
-     * - @ref R_CGC_VersionGet()
-     * @param[out]  p_version   Code and API version used
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * p_version);
 } cgc_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_comparator_api.h

@@ -51,10 +51,6 @@ FSP_HEADER
  * Macro definitions
  **********************************************************************************************************************/
 
-/** Version Number of API.  */
-#define COMPARATOR_API_VERSION_MAJOR    (1U) // DEPRECATED
-#define COMPARATOR_API_VERSION_MINOR    (1U) // DEPRECATED
-
 /*****************************************************************************
  * Typedef definitions
  ******************************************************************************/
@@ -204,16 +200,6 @@ typedef struct st_comparator_api
      * @param[in]  p_ctrl   Pointer to instance control block
      */
     fsp_err_t (* close)(comparator_ctrl_t * const p_ctrl);
-
-    /* DEPRECATED Retrieve the API version.
-     * @par Implemented as
-     * - @ref R_ACMPHS_VersionGet()
-     * - @ref R_ACMPLP_VersionGet()
-     *
-     * @pre This function retrieves the API version.
-     * @param[in]  p_version   Pointer to version structure
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * const p_version);
 } comparator_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_crc_api.h

@@ -52,9 +52,6 @@ FSP_HEADER
  * Macro definitions
  **********************************************************************************************************************/
 
-#define CRC_API_VERSION_MAJOR    (1U)  // DEPRECATED
-#define CRC_API_VERSION_MINOR    (0U)  // DEPRECATED
-
 /**********************************************************************************************************************
  * Typedef definitions
  **********************************************************************************************************************/
@@ -213,12 +210,6 @@ typedef struct st_crc_api
      * @param[out] crc_result     The calculated value of the CRC calculation.
      **/
     fsp_err_t (* calculate)(crc_ctrl_t * const p_ctrl, crc_input_t * const p_crc_input, uint32_t * p_crc_result);
-
-    /* DEPRECATED Get the driver version based on compile time macros.
-     * @par Implemented as
-     * - @ref R_CRC_VersionGet()
-     **/
-    fsp_err_t (* versionGet)(fsp_version_t * version);
 } crc_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_ctsu_api.h

@@ -50,10 +50,7 @@ FSP_HEADER
 /**********************************************************************************************************************
  * Macro definitions
  **********************************************************************************************************************/
-#define CTSU_API_VERSION_MAJOR    (1U)     // DEPRECATED
-#define CTSU_API_VERSION_MINOR    (2U)     // DEPRECATED
-
-#define CTSU_COUNT_MAX            (0xFFFF) ///< Value of Maximum count
+#define CTSU_COUNT_MAX    (0xFFFF)
 
 /**********************************************************************************************************************
  * Typedef definitions
@@ -112,7 +109,8 @@ typedef enum e_ctsu_mode
     CTSU_MODE_MUTUAL_FULL_SCAN = 3,    ///< Mutual capacitance full scan mode
     CTSU_MODE_MUTUAL_CFC_SCAN  = 7,    ///< Mutual capacitance cfc scan mode (CTSU2 Only)
     CTSU_MODE_CURRENT_SCAN     = 9,    ///< Current scan mode (CTSU2 Only)
-    CTSU_MODE_CORRECTION_SCAN  = 17    ///< Correction scan mode (CTSU2 Only)
+    CTSU_MODE_CORRECTION_SCAN  = 17,   ///< Correction scan mode (CTSU2 Only)
+    CTSU_MODE_DIAGNOSIS_SCAN   = 33    ///< Diagnosis scan mode
 } ctsu_md_t;
 
 /** CTSU Non-Measured Channel Output Select (CTSU2 Only) */
@@ -234,6 +232,14 @@ typedef struct st_ctsu_api
      */
     fsp_err_t (* dataGet)(ctsu_ctrl_t * const p_ctrl, uint16_t * p_data);
 
+    /** Diagnosis.
+     * @par Implemented as
+     * - @ref R_CTSU_Diagnosis()
+     *
+     * @param[in]  p_ctrl       Pointer to control structure.
+     */
+    fsp_err_t (* diagnosis)(ctsu_ctrl_t * const p_ctrl);
+
     /** Specify callback function and optional context pointer and working memory pointer.
      * @par Implemented as
      * - @ref R_CTSU_CallbackSet()
@@ -254,15 +260,6 @@ typedef struct st_ctsu_api
      * @param[in]  p_ctrl       Pointer to control structure.
      */
     fsp_err_t (* close)(ctsu_ctrl_t * const p_ctrl);
-
-    /* DEPRECATED Return the version of the driver.
-     * @par Implemented as
-     * - @ref R_CTSU_VersionGet()
-     *
-     * @param[in]  p_ctrl       Pointer to control structure.
-     * @param[out] p_data       Memory address to return version information to.
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * const p_data);
 } ctsu_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */

ra/fsp/inc/api/r_dac_api.h

@@ -50,8 +50,6 @@ FSP_HEADER
 /**********************************************************************************************************************
  * Macro definitions
  **********************************************************************************************************************/
-#define DAC_API_VERSION_MAJOR    (1U)  // DEPRECATED
-#define DAC_API_VERSION_MINOR    (1U)  // DEPRECATED
 
 /**********************************************************************************************************************
  * Typedef definitions
@@ -134,15 +132,6 @@ typedef struct st_dac_api
      * @param[in]   p_ctrl     Control block set in @ref dac_api_t::open call for this timer.
      */
     fsp_err_t (* stop)(dac_ctrl_t * const p_ctrl);
-
-    /* DEPRECATED Get version and store it in provided pointer p_version.
-     * @par Implemented as
-     * - @ref R_DAC_VersionGet()
-     * - @ref R_DAC8_VersionGet()
-     *
-     * @param[out]  p_version  Code and API version used.
-     */
-    fsp_err_t (* versionGet)(fsp_version_t * p_version);
 } dac_api_t;
 
 /** This structure encompasses everything that is needed to use an instance of this interface. */