API Reference

This section includes the FSP API Reference for the Module and Interface level functions.

[detail level 123]

▼BSP	Common code shared by FSP drivers
Common Error Codes
►MCU Board Support Package	The BSP is responsible for getting the MCU 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
RZT2H
RZT2L
RZT2M
RZT2ME
BSP I/O access	This module provides basic read/write/toggle access to port pins and read/write access to port
▼Modules	Modules are the smallest unit of software available in the FSP. Each module implements one interface
►Analog	Analog Modules
ADC (r_adc)	Driver for the and ADC12 peripherals on RZ microprocessor. This module implements the ADC Interface
Delta-Sigma Interface (r_dsmif)	Driver for the DSMIF peripheral on RZ microprocessor. This module implements the ADC Interface
►Connectivity	Connectivity Modules
CAN FD (r_canfd)	Driver for the CANFD peripheral on RZ microprocessor. This module implements the CAN Interface
I2C Master (r_iic_master)	Driver for the IIC peripheral on RZ microprocessor. This module implements the I2C Master Interface
I2C Slave (r_iic_slave)	Driver for the IIC peripheral on RZ microprocessor. This module implements the I2C Slave Interface
PCIE_EP (r_pcie_ep)	Driver for the PCI peripheral on RZ Microprocessor. This module implements the PCI Interface
PCIE_RC (r_pcie_rc)	Driver for the PCI peripheral on RZ Microprocessor. This module implements the PCI Interface
I2C Master (r_sci_i2c)	Driver for the SCI peripheral on RZ microprocessor. This module implements the I2C Master Interface
SMCI (r_sci_smci)	Driver for the SCI peripheral on RZ microprocessor. This module implements the SMCI Interface
SPI (r_sci_spi)	Driver for the SCI peripheral on RZ microprocessor. This module implements the SPI Interface
UART (r_sci_uart)	Driver for the SCI peripheral on RZ microprocessor. This module implements the UART Interface
SPI (r_spi)	Driver for the SPI peripheral on RZ microprocessor. This module implements the SPI Interface
USB (r_usb_basic)	Driver for the USB peripheral on RZ microprocessors. This module implements the USB Interface
USB HCDC (r_usb_hcdc)	This module provides a USB Host Communications Device Class (HCDC) driver. It implements the USB HCDC Interface
USB HHID (r_usb_hhid)	This module provides a USB Host Human Interface Device Class Driver (HHID). It implements the USB HHID Interface
USB HMSC (r_usb_hmsc)	This module provides a USB Host Mass Storage Class (HMSC) driver. It implements the USB HMSC Interface
USB HVND (r_usb_hvnd)
USB PCDC (r_usb_pcdc)	This module provides a USB Peripheral Communications Device Class Driver (PCDC). It implements the USB PCDC Interface
USB PMSC (r_usb_pmsc)	This module provides a USB Peripheral Mass Storage Class (PMSC) driver. It implements the USB PMSC Interface
USB PVND (r_usb_pvnd)
►Graphics	Graphics Modules
LCD Controller (r_lcdc)	Driver for the LCDC peripheral on RZ microprocessor. This module implements the Display Interface
►Input	Input Modules
External IRQ (r_icu)	Driver for the ICU peripheral on RZ microprocessor. This module implements the External IRQ Interface
►Monitoring	Monitoring Modules
CRC (r_crc)	Driver for the CRC peripheral on RZ microprocessor. This module implements the CRC Interface
Data Operation Circuit (r_doc)	Driver for the DOC peripheral on RZ microprocessor. This module implements the DOC Interface
Watchdog (r_wdt)	Driver for the WDT peripheral on RZ microprocessor. This module implements the WDT Interface
►Networking	Networking Modules
Ethernet PHY (r_ether_phy)	The Ethernet PHY module (r_ether_phy) provides an API for standard Ethernet PHY communications applications. It implements the Ethernet PHY Interface
Ethernet SELECTOR (r_ether_selector)	Driver for the Ether Selector peripheral on RZ microprocessor. This module implements the Ethernet Selector Interface
Ethernet Switch (r_ethsw)	Provides API for using Ethernet Switch. It implements the Ethernet Switch Interface
Ethernet (r_gmac)	Driver for the Ethernet peripheral on RZ microprocessor. This module implements the Ethernet Interface
Ethernet (r_gmac_b)	Driver for the Ethernet peripheral on RZ microprocessor. This module implements the Ethernet Interface
EtherCAT SSC Port (rm_ethercat_ssc_port)	Middleware for EtherCAT Slave Stack Code (SSC) on RZ microprocessors. This module implements the EtherCAT SSC Interface
FreeRTOS+TCP Wrapper to r_ether (rm_freertos_plus_tcp)	Middleware for using TCP on RZ microprocessor
►RTOS	RTOS Modules
FreeRTOS Port (rm_freertos_port)	FreeRTOS port for RZ/T2M MPU
►Security	Security Modules
Renesas Secure IP (r_rsip_protected)	Driver for the Renesas Secure IP on RZ microprocessors. This module implements the RSIP Interface
►Sensor	Sensor Modules
Temperature Sensor Unit (r_tsu)	Driver for the TSU peripheral on RZ microprocessor. This module implements the ADC Interface
Temperature Sensor Unit (r_tsu_b)	Driver for the TSU peripheral on RZ MPUs. This module implements the ADC Interface
►Storage	Storage Modules
NOR Flash (r_bsc_nor)	Driver for the BSC peripheral on RZ microprocessor. This module implements the NOR Flash Interface
SD/MMC (r_sdhi)	Driver for the SD/MMC Host Interface (SDHI) peripheral on RZ microprocessor. This module implements the SD/MMC Interface
HyperBus (r_xspi_hyper)	Driver for the xSPI peripheral on RZ microprocessor. This module implements the HyperBus Interface
OSPI Flash (r_xspi_ospi)	Driver for the xSPI peripheral on RZ microprocessor. This module implements the SPI Flash Interface
QSPI Flash (r_xspi_qspi)	Driver for the xSPI peripheral on RZ microprocessor. This module implements the SPI Flash Interface
Block Media SD/MMC (rm_block_media_sdmmc)	Middleware to implement the block media interface on SD cards. This module implements the Block Media Interface
Block Media USB (rm_block_media_usb)	Middleware to implement the block media interface on USB mass storage devices. This module implements the Block Media Interface
Block Media Custom Implementation (rm_block_media_user)	Middleware that implements a block media interface on the media of your choice. This module implements the Block Media Interface
FreeRTOS+FAT Port for RZT (rm_freertos_plus_fat)	Middleware for the FAT File System control on RZ microprocessor
►System	System Modules
Bus State Controller (r_bsc)	Driver for the BSC peripheral on RZ microprocessor. This module implements the External Bus Interface
SDRAM (r_bsc_sdram)	Driver for the BSC peripheral on RZ microprocessor. This module implements the SDRAM Interface
Clock Generation Circuit (r_cgc)	Driver for the CGC peripheral on RZ microprocessor. This module implements the CGC Interface
Event Link Controller (r_elc)	Driver for the ELC peripheral on RZ microprocessor. This module implements the ELC Interface
Error (r_icu_error)	Driver for the ICU peripheral on RZ microprocessor. This module implements the ERROR Interface
Inter-CPU IRQ on ICU (r_icu_inter_cpu_irq)	Driver for the ICU peripheral on RZ microprocessor. This module implements the Inter CPU IRQ Interface
I/O Ports (r_ioport)	Driver for the I/O Ports peripheral on RZ microprocessors. This module implements the I/O Port Interface
Shared Memory (r_shared_memory)	Driver for the shared memory function on RZ microprocessor. This module implements the Shared Memory Interface
►Timers	Timers Modules
Compare Match Timer (r_cmt)	Driver for the CMT peripherals on RZ microprocessor. This module implements the Timer Interface
Compare Match Timer W (r_cmtw)	Driver for the CMTW peripheral on RZ microprocessor. This module implements the Timer Interface
General PWM Timer (r_gpt)	Driver for the GPT peripherals on RZ microprocessor. This module implements the Timer Interface
General PWM Timer Three-Phase Motor Control Driver (r_gpt_three_phase)	Driver for 3-phase motor control using the GPT peripheral on RZ microprocessor. This module implements the Three-Phase Interface
Multi-Function Timer Pulse Unit 3 (r_mtu3)	Driver for the MTU3 peripherals on RZ microprocessor. This module implements the Timer Interface
Multi-Function Timer Pulse Unit 3 Three-Phase Motor Control Driver (r_mtu3_three_phase)	Driver for 3-phase motor control using the MTU3 peripheral on RZ microprocessor. This module implements the Three-Phase Interface
Port Output Enable 3 (r_poe3)	Driver for the POE3 peripheral on RZ microprocessor. This module implements the POE3 Interface
Port Output Enable for GPT (r_poeg)	Driver for the POEG peripheral on RZ microprocessor. This module implements the POEG Interface
Real Time Clock (r_rtc)	Driver for the RTC peripheral on RZ microprocessor. This module implements the RTC Interface
►Transfer	Transfer Modules
Transfer (r_dmac)	Driver for the DMAC peripheral on RZ microprocessor. This module implements the Transfer Interface
▼Interfaces	FSP 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
►Analog	Analog Interfaces
ADC Interface	Interface for A/D Converters
►Connectivity	Connectivity Interfaces
CAN Interface	Interface for CAN peripheral
I2C Master Interface	Interface for I2C master communication
I2C Slave Interface	Interface for I2C slave communication
PCI Interface	Interface for PCI communications
SMCI Interface	Interface for SMCI communications
SPI Interface	Interface for SPI communications
UART Interface	Interface for UART communications
USB Interface	Interface for USB functions
USB HCDC Interface	Interface for USB HCDC functions
USB HHID Interface	Interface for USB HHID functions
USB HMSC Interface	Interface for USB HMSC functions
USB PCDC Interface	Interface for USB PCDC functions
USB PMSC Interface	Interface for USB PMSC functions
►Graphics	Graphics Interfaces
Display Interface	Interface for LCD panel displays
►Input	Input Interfaces
External IRQ Interface	Interface for detecting external interrupts
►Monitoring	Monitoring Interfaces
CRC Interface	Interface for cyclic redundancy checking
DOC Interface	Interface for the Data Operation Circuit
WDT Interface	Interface for watch dog timer functions
►Networking	Networking Interfaces
Ethernet Interface	Interface for Ethernet functions
Ethernet PHY Interface	Interface for Ethernet PHY functions
Ethernet Selector Interface	Interface for Ethernet Selector functions
Ethernet Switch Interface	Interface for Ethernet Switch functions
EtherCAT SSC Interface	Interface for EtherCAT SSC functions
►Security	Security Interfaces
RSIP Interface	Interface for Renesas Secure IP (RSIP) functions
►Storage	Storage Interfaces
HyperBus Interface	Interface for accessing memory device via HyperBus
NOR Flash Interface	Interface for external nor flash communication
SD/MMC Interface	Interface for accessing SD, eMMC, and SDIO devices
SPI Flash Interface	Interface for accessing external SPI flash devices
Block Media Interface	Interface for block media memory access
FreeRTOS+FAT Port Interface	Interface for FreeRTOS+FAT port
►System	System Interfaces
CGC Interface	Interface for clock generation
ELC Interface	Interface for the Event Link Controller
ERROR Interface	Interface for the ERROR event handling
External Bus Interface	Interface for external bus communication
Inter CPU IRQ Interface	Interface for INTCPU interrupt
I/O Port Interface	Interface for accessing I/O ports and configuring I/O functionality
SDRAM Interface	Interface for external sdram communication
Shared Memory Interface	Interface for Shared Memory
►Timers	Timers Interfaces
POE3 Interface	Interface for the Port Output Enable 3
POEG Interface	Interface for the Port Output Enable for GPT
RTC Interface	Interface for accessing the Realtime Clock
Three-Phase Interface	Interface for three-phase timer functions
Timer Interface	Interface for timer functions
►Transfer	Transfer Interfaces
Transfer Interface	Interface for data transfer functions