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
►MPU Board Support Package	The 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
RZA3UL
BSP I/O access	This module provides basic read/write access to port pins
▼Modules	Modules are the smallest unit of software available in the FSP. Each module implements one interface
►Analog	Analog Modules
ADC (r_adc_c)	Driver for the ADC peripheral on RZ/A3UL. This module implements the ADC Interface
►AI	Artifical Intelligence Modules
Reality AI Data Collector (rm_rai_data_collector)	Middleware to implement the Data Collector for Reality AI applications. This module implements the Data Collector Interface
Reality AI Data Shipper (rm_rai_data_shipper)	Middleware to implement the Data Shipper for Reality AI applications. This module implements the Data Shipper Interface
►Connectivity	Connectivity Modules
Controller Area Network - Flexible Data (r_canfd)	Driver for the CANFD peripheral on RZ MPUs. This module implements the CAN Interface
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
UART (r_sci_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
Serial Sound Interface (r_ssi)	Driver for the SSIF peripheral on RZ MPUs. This module implements the I2S Interface
USB (r_usb_basic)	Driver for the USB peripheral on RZ MCUs. This module implements the USB Interface
USB Host Human Interface Device Class Driver (r_usb_hhid)	This module provides a USB Host Human Interface Device Class Driver (HHID). It implements the USB HHID Interface
USB Host Mass Storage Class Driver (r_usb_hmsc)	This module provides a USB Host Mass Storage Class (HMSC) driver. It implements the USB HMSC Interface
USB Peripheral Communications Device Class (r_usb_pcdc)	This module provides a USB Peripheral Communications Device Class Driver (PCDC). It implements the USB PCDC Interface
I2C Communication Device (rm_comms_i2c)	Middleware to implement the I2C communications interface. This module implements the Communicatons Middleware Interface
UART Communication Device (rm_comms_uart)	Middleware to implement a generic communications interface over UART. This module implements the Communicatons Middleware Interface
USBX Porting Layer (rm_usbx_port)	Middleware for the Azure RTOS USBX Porting Layer on RZ MPUs
►Graphics	Graphics Modules
Camera Data Receiving Unit (r_cru)	Driver for the CRU peripheral on RZ MPUs. This module implements the Camera Interface
Image Scaling Unit (r_isu)	Driver for the ISU peripheral on RZ MPUs. This module implements the Image Scaling Interface
LCD Controller (r_lcdc)	Driver for the LCDC peripheral on RZ MPUs. This module implements the Display Interface
Azure RTOS GUIX Port (rm_guix_port)	Middleware for the Azure RTOS GUIX Port on RZ MPUs
►Input	Input 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 INTC_TINT peripheral on RZ MPUs. This module implements the External IRQ Interface
►Monitoring	Monitoring Modules
Watchdog (r_wdt)	Driver for the WDT peripheral on RZ MCUs. This module implements the WDT Interface
►Networking	Networking Modules
Ethernet (r_gether)	Driver for the Ethernet peripheral on RZ MPUs. This module implements the Ethernet Interface
Ethernet PHY (r_gether_phy)	The Ethernet PHY module (r_gether_phy) provides an API for standard Ethernet PHY communications applications that use the E-MAC peripheral. It implements the Ethernet PHY Interface
FreeRTOS Plus TCP (rm_freertos_plus_tcp)	Middleware for using TCP on RZ MPUs
Azure RTOS NetX Duo Ether Driver (rm_netxduo_ether)	Middleware for the Azure RTOS NetX Duo Ether Driver on RZ MPUs
►RTOS	RTOS Modules
FreeRTOS Port (rm_freertos_port)	FreeRTOS port for RZ MPUs
Azure RTOS ThreadX Port (rm_threadx_port)	ThreadX port for RZ MCUs
►Sensor	Sensor Modules
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
►Storage	Storage Modules
SD/MMC Host Interface (r_sdhi)	Driver for the SD/MMC Host Interface (SDHI) peripheral on RZ MPUs. This module implements the SD/MMC Interface
Quad Serial Peripheral Interface Flash (r_spibsc)	Driver for the SPIBSC peripheral on RZ MPUs. This module implements the SPI Flash Interface
SD/MMC Block Media Implementation (rm_block_media_sdmmc)	Middleware to implement the block media interface on SD cards. This module implements the Block Media Interface
USB HMSC Block Media Implementation (rm_block_media_usb)	Middleware to implement the block media interface on USB mass storage devices. This module implements the Block Media Interface
Azure RTOS FileX Block Media I/O Driver (rm_filex_block_media)	Middleware for the Azure RTOS FileX File System control using Block Media on RZ MPUs
FreeRTOS+FAT Port (rm_freertos_plus_fat)	Middleware for the FAT File System control on RZ/A MPUs
►System	System Modules
I/O Ports (r_ioport)	Driver for the I/O Ports peripheral on RZ MPUs. This module implements the I/O Port Interface
Memory Managing Unit (r_mmu)	Driver for the MMU peripheral on RZ MPUs. This module implements the Memory Managing Unit Interface
►Timers	Timers Modules
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 microprocessor. This module implements the Timer Interface
►Transfer	Transfer Modules
Direct Memory Access Controller (r_dmac)	Driver for the DMAC peripheral on RZ MPUs. This module implements the Transfer Interface
▼Interfaces	The 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
►AI	AI Interfaces
Data Collector Interface	Interface for RAI Data Collector
Data Shipper Interface	Interface for RAI Data Shipper
►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
I2S Interface	Interface for I2S audio communication
SPI Interface	Interface for SPI communications
UART Interface	Interface for UART communications
USB Interface	Interface for USB 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
Communicatons Middleware Interface	Interface for Communications Middleware functions
►Graphics	Graphics Interfaces
Camera Interface	Interface for camera
Display Interface	Interface for LCD panel displays
Image Scaling Interface	Interface for image scaling
►Input	Input Interfaces
External IRQ Interface	Interface for detecting external interrupts
►Monitoring	Monitoring Interfaces
CRC Interface	Interface for cyclic redundancy checking
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
►Sensor	Sensor Interfaces
HS300X Middleware Interface	Interface for HS300X Middleware functions
HS400X Middleware Interface	Interface for HS400X Middleware functions
►Storage	Storage Interfaces
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
FileX Block Media Port Interface	Interface for FileX Block Media port
FreeRTOS+FAT Port Interface	Interface for FreeRTOS+FAT port
►System	System Interfaces
I/O Port Interface	Interface for accessing I/O ports and configuring I/O functionality
Memory Managing Unit Interface	Interface for Memory Managing Unit(MMU) functions
►Timers	Timers Interfaces
Timer Interface	Interface for timer functions
►Transfer	Transfer Interfaces
Transfer Interface	Interface for data transfer functions