RZV Flexible Software Package Documentation  Release v3.0.0

 
API Reference
This section includes the FSP API Reference for the Module and Interface level functions.
[detail level 123]
 BSPCommon code shared by FSP drivers
 Common Error Codes
 MPU Board Support PackageThe BSP is responsible for getting the MPU from reset to the user's application. Before reaching the user's application, the BSP sets up the stacks, heap, clocks, interrupts, C runtime environment, and stack monitor
 RZV2H
 RZV2L
 RZV2N
 BSP I/O accessThis module provides basic read/write access to port pins
 ModulesModules are the smallest unit of software available in FSP. Each module implements one interface
 AnalogAnalog Modules
 Analog to Digital Converter (r_adc_c)Driver for the ADC peripheral on RZ MPUs. This module implements the ADC Interface
 Analog to Digital Converter (r_adc_e)Driver for the and ADC12 peripherals on RZ MPUs. This module implements the ADC Interface
 AudioAudio Modules
 PDM Interface (r_pdm)Driver for the PDM peripheral on RZ MPUs. This module implements the PDM Interface
 ConnectivityConnectivity Modules
 Controller Area Network - Flexible Data (r_canfd)Driver for the CANFD peripheral on RZ MPUs. This module implements the CAN Interface
 I3C (r_i3c_b)Driver for the I3C peripheral on RZ MPU. This module implements the I3C Interface
 Message Handling Unit for non secure channels (r_mhu_b_ns)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (for secure and non secure channels)
 Message Handling Unit for non-secure software interrupt receive (r_mhu_b_ns_swint_get)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (Software Interrupt Get)
 Message Handling Unit for non-secure software interrupt generation (r_mhu_b_ns_swint_set)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (Software Interrupt Set)
 Message Handling Unit for secure channels (r_mhu_b_s)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (for secure and non secure channels)
 Message Handling Unit for non secure channels (r_mhu_ns)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (for secure and non secure channels)
 Message Handling Unit for non-secure software interrupt receive (r_mhu_ns_swint_get)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (Software Interrupt Get)
 Message Handling Unit for non-secure software interrupt generation (r_mhu_ns_swint_set)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (Software Interrupt Set)
 Message Handling Unit for secure channels (r_mhu_s)Driver for the MHU peripherals on RZ MPUs. This module implements the MHU Interface (for secure and non secure channels)
 I2C Master on RIIC (r_riic_master)Driver for the RIIC peripheral on RZ MPUs. This module implements the I2C Master Interface
 I2C Slave (r_riic_slave)Driver for the RIIC peripheral on RZ MPUs. This module implements the I2C Slave Interface
 Renesas Serial Peripheral Interface (r_rspi)Driver for the RSPI peripheral on RZ MPUs. This module implements the SPI Interface
 I2C Master (r_sci_b_i2c)Driver for the SCI_B peripheral on RZ MPUs. This module implements the I2C Master Interface
 SPI (r_sci_b_spi)Driver for the SCI peripheral on RZ MPUs. This module implements the SPI Interface
 UART (r_sci_b_uart)Driver for the SCI peripheral on RZ MPUs. This module implements the UART Interface
 Serial Communications Interface (SCIF) UART (r_scif_uart)Driver for the SCIF peripheral on RZ MPUs. This module implements the UART Interface
 SPI (r_spi_b)Driver for the SPI peripheral on RZ MPUs. This module implements the SPI Interface
 I2C Communication Device (rm_comms_i2c)Middleware to implement the I2C communications interface. This module implements the Communicatons Middleware Interface
 InputInput Modules
 External IRQ (r_intc_irq)Driver for the INTC_IRQ peripheral on RZ MPUs. This module implements the External IRQ Interface
 External IRQ (r_intc_nmi)Driver for the INTC_NMI peripheral on RZ MPUs. This module implements the External IRQ Interface
 External IRQ (r_intc_tint)Driver for the Interrupt Controller peripheral on RZ MPUs. This module implements the External IRQ Interface
 MonitoringMonitoring Modules
 CRC (r_crc)Driver for the CRC peripheral on RZ MPUs. This module implements the CRC Interface
 Watchdog (r_wdt)Driver for the WDT peripheral on RZ MPUs. This module implements the WDT Interface
 RTOSRTOS Modules
 FreeRTOS Port (rm_freertos_port)FreeRTOS port for RZ MPUs
 SensorSensor Modules
 Temperature Sensor Unit (r_tsu_b)Driver for the TSU peripheral on RZ MPUs. This module implements the ADC Interface
 HS300X Temperature/Humidity Sensor (rm_hs300x)Middleware to implement the HS300X sensor interface. This module implements the HS300X Middleware Interface
 HS400X Temperature/Humidity Sensor (rm_hs400x)Middleware to implement the HS400X sensor interface. This module implements the HS400X Middleware Interface
 ZMOD4XXX Gas Sensor (rm_zmod4xxx)Middleware to implement the ZMOD4XXX sensor interface. This module implements the ZMOD4XXX Middleware Interface
 StorageStorage Modules
 Expanded Serial Peripheral Interface (xSPI) QSPI (r_xspi_qspi)Driver for the xSPI peripheral on RZ MPUs. This module implements the SPI Flash Interface
 SystemSystem Modules
 Event Link Controller (r_elc)Driver for the ELC peripheral on RZ MPUs. This module implements the ELC Interface
 I/O Ports (r_ioport)Driver for the I/O Ports peripheral on RZ MPUs. This module implements the I/O Port Interface
 TimersTimers Modules
 Compare Match Timer W (r_cmtw)Driver for the CMTW peripheral on RZ MPUs. This module implements the Timer Interface
 General PWM Timer (r_gpt)Driver for the GPT peripheral on RZ MPUs. This module implements the Timer Interface
 General Timer (r_gtm)Driver for the GTM peripherals on RZ MPUs. This module implements the Timer Interface
 Multi-Function Timer Pulse Unit 3 (r_mtu3)Driver for the MTU3 peripherals on RZ MPUs. This module implements the Timer Interface
 Port Output Enable for GPT (r_poeg)Driver for the POEG peripheral on RZ MPUs. This module implements the POEG Interface
 Realtime Clock (r_rtc)Driver for the RTC peripheral on RZ MPUs. This module implements the RTC Interface
 TransferTransfer Modules
 Direct Memory Access Controller (r_dmac_b)Driver for the DMAC peripheral on RZ MPUs. This module implements the Transfer Interface
 InterfacesFSP interfaces provide APIs for common functionality. They can be implemented by one or more modules. Modules can use other modules as dependencies using this interface layer
 AnalogAnalog Interfaces
 ADC InterfaceInterface for A/D Converters
 AudioAudio Interfaces
 PDM InterfaceInterface for PDM audio communication
 ConnectivityConnectivity Interfaces
 CAN InterfaceInterface for CAN peripheral
 I2C Master InterfaceInterface for I2C master communication
 I2C Slave InterfaceInterface for I2C slave communication
 I3C InterfaceInterface for I3C
 SPI InterfaceInterface for SPI communications
 UART InterfaceInterface for UART communications
 Communicatons Middleware InterfaceInterface for Communications Middleware functions
 InputInput Interfaces
 External IRQ InterfaceInterface for detecting external interrupts
 MonitoringMonitoring Interfaces
 CRC InterfaceInterface for cyclic redundancy checking
 WDT InterfaceInterface for watch dog timer functions
 SensorSensor Interfaces
 HS300X Middleware InterfaceInterface for HS300X Middleware functions
 HS400X Middleware InterfaceInterface for HS400X Middleware functions
 ZMOD4XXX Middleware InterfaceInterface for ZMOD4XXX Middleware functions
 StorageStorage Interfaces
 SPI Flash InterfaceInterface for accessing external SPI flash devices
 SystemSystem Interfaces
 ELC InterfaceInterface for the Event Link Controller
 I/O Port InterfaceInterface for accessing I/O ports and configuring I/O functionality
 MHU Interface (for secure and non secure channels)Interface for Message Handling Unit
 MHU Interface (Software Interrupt Get)Interface for Message Handling Unit (Software Interrupt Get)
 MHU Interface (Software Interrupt Set)Interface for Message Handling Unit (Software Interrupt Set)
 TimersTimers Interfaces
 POEG InterfaceInterface for the Port Output Enable for GPT
 RTC InterfaceInterface for accessing the Realtime Clock
 Timer InterfaceInterface for timer functions
 TransferTransfer Interfaces
 Transfer InterfaceInterface for data transfer functions