API Reference

This section includes the SSP API Reference for the Framework and HAL level functions.

[detail level 1234]

▼Renesas Synergy Software Package Reference
►Shared
Common Error Codes
►Framework Interfaces
ADC Periodic Framework Interface	RTOS-integrated ADC Periodic Framework Interface
Audio Framework Interface	RTOS-integrated Audio Framework Interface
Audio Playback Framework Interface	RTOS-integrated Audio Playback Framework Interface
Audio Recording Framework Interface	RTOS-integrated Audio Recording Framework Interface
SF BLE Framework Interface	RTOS-integrated SF BLE Framework Interface
SF BLE On-Board Profile Framework Interface	RTOS-integrated SF BLE On-Board Profile Framework Interface
SF BLE Alert Notification Profile Framework Interface	RTOS-integrated SF BLE Alert Notification Profile Framework Interface
SF BLE Battery Service Profile Framework Interface	RTOS-integrated SF BLE Battery Service Profile Framework Interface
SF BLE Blood Pressure Profile Framework Interface	RTOS-integrated SF BLE Blood Pressure Profile Framework Interface
SF BLE Current Time Service Profile Framework Interface	RTOS-integrated SF BLE Current Time Service Profile Framework Interface
SF BLE Find Me Profile Framework Interface	RTOS-integrated SF BLE Find Me Profile Framework Interface
SF BLE HID Over GATT Profile Framework Interface	RTOS-integrated SF BLE HID Over GATT Profile Framework Interface
SF BLE Heart Rate Profile Framework Interface	RTOS-integrated SF BLE Heart Rate Profile Framework Interface
SF BLE Health Thermometer Profile Framework Interface	RTOS-integrated SF BLE Health Thermometer Profile Framework Interface
SF BLE Immediate Alert Profile Framework Interface	RTOS-integrated SF BLE Immediate Alert Profile Framework Interface
SF BLE Next DST Change Service Profile Framework Interface	RTOS-integrated SF BLE Next DST Change Service Profile Framework Interface
SF BLE Phone Alert Status Profile Framework Interface	RTOS-integrated SF BLE Phone Alert Status Profile Framework Interface
SF BLE Proximity Profile Framework Interface	RTOS-integrated SF BLE Proximity Profile Framework Interface
SF BLE Reference Time Update Service Profile Framework Interface	RTOS-integrated SF BLE Reference Time Update Service Profile Framework Interface
SF BLE Scan Parameters Service Profile Framework Interface	RTOS-integrated SF BLE Scan Parameters Service Profile Framework Interface
SF BLE Time Information Profile Framework Interface	RTOS-integrated SF BLE Time Information Profile Framework Interface
Block Media Framework Interface	RTOS-integrated File system Interface to access Synergy block media devices
SF CELLULAR Framework Interface	RTOS-integrated SF CELUULAR Framework Interface
SF CELLULAR NSAL Framework Interface	RTOS-integrated SF CELLULAR NSAL Framework Interface
SF Socket CELLULAR Framework Interface	RTOS-integrated SF Socket Cellular Framework Interface
Communications Framework Interface	RTOS-integrated communications Framework Interface
Console Framework Interface	RTOS-integrated Console Framework Interface
SSP Crypto Framework Common Module Interface	Interface definition for Synergy Crypto Framework module
SSP Crypto Cipher Framework Interface	Interface definition for Synergy Crypto Cipher Framework module
SSP Crypto HASH Framework Interface	Interface definition for Synergy Crypto HASH Framework module
SSP Crypto Key Framework Interface	Interface definition for Synergy Crypto Key Framework module
SSP Crypto Key Installation Framework Interface	Interface definition for Synergy Crypto Key Installation Framework module
SSP Crypto Signature Framework Interface	Interface definition for Synergy Crypto Signature Framework module
SSP Crypto TRNG Framework Interface	Interface definition for Synergy Crypto TRNG Framework module
GUIX Interface	Interface definition for Adapting Microsoft GUIX for Synergy graphics drivers
External IRQ Framework Interface	RTOS-integrated External IRQ Framework Interface
I2C Framework	RTOS-integrated I2C Framework Interface
JPEG Decode Framework Interface	RTOS-integrated JPEG Decode Framework Interface
Memory interface	Interface for Memory API
Messaging Framework Interface	RTOS-integrated Messaging Framework Interface
Power Profiles V2 Framework Interface	Power Profiles Framework Interface
SF Socket WIFI Framework Interface	RTOS-integrated SF Socket WIFI Framework Interface
SPI Framework Interface	RTOS-integrated SPI Framework Interface
Thread Monitor Framework Interface	RTOS-integrated Framework Interface for monitoring of threads
CTSU v2 Framework Interface	CTSU v2 Framework Interface
Touch chip Interface	RTOS-integrated Touch chip Interface
Touch Panel Framework Interface	RTOS-integrated Touch Panel Framework Interface
SF WIFI Framework Interface	RTOS-integrated SF WIFI Framework Interface
SF WIFI NSAL Interface	RTOS-integrated SF WIFI NSAL Framework Interface
SF WIFI On-Chip Stack Interface	RTOS-integrated SF WIFI On-Chip Stack Interface
SF WIFI QCA4010 Framework Interface	RTOS-integrated SF WIFI QCA4010 Framework Interface
SF WIFI QCA4010 On-Chip Interface	RTOS-integrated SF Socket Wifi Framework Interface
SF Socket WIFI Framework Interface	RTOS-integrated SF Socket WIFI Framework Interface
SF WIFI NSAL on NetX	NetX NSAL interface implementation header file
►BLE Framework Interface on RL78G1D	RTOS-integrated BLE Interface Framework example. Implementation of RL78G1D BLE Driver. It implements the following interfaces:
BLE Alert Notification Profile Interface Framework on RL78G1D	RTOS-integrated BLE Alert Notification Profile Framework example. Implementation of RL78G1D BLE Alert Notification Profile Interface Driver. It implements the following interfaces:
BLE Blood Pressure Profile Interface Framework on RL78G1D	RTOS-integrated BLE Blood Pressure Profile Framework example. Implementation of RL78G1D BLE Blood Pressure Profile Interface Driver. It implements the following interfaces:
BLE Find Me Profile Interface Framework on RL78G1D	RTOS-integrated BLE Find Me Profile Framework example. Implementation of RL78G1D BLE Find Me Profile Interface Driver. It implements the following interfaces:
BLE HID Over GATT Profile Interface Framework on RL78G1D	RTOS-integrated BLE HID Over GATT Profile Framework example. Implementation of RL78G1D BLE HID Over GATT Profile Interface Driver. It implements the following interfaces:
BLE Heart Rate Profile Interface Framework on RL78G1D	RTOS-integrated BLE Heart Rate Profile Framework example. Implementation of RL78G1D BLE Heart Rate Profile Interface Driver. It implements the following interfaces:
BLE Health Thermometer Profile Interface Framework on RL78G1D	RTOS-integrated BLE Health Thermometer Profile Framework example. Implementation of RL78G1D BLE Health Thermometer Profile Interface Driver. It implements the following interfaces:
BLE On-Board Profile Framework Interface on RL78G1D	RTOS-integrated BLE On-Board Profile Framework example. Implementation of RL78G1D BLE On-Board Profile Interface Driver. It implements the following interfaces:
BLE Phone Alert Status Profile Interface Framework on RL78G1D	RTOS-integrated BLE Phone Alert Status Profile Framework example. Implementation of RL78G1D BLE Phone Alert Status Profile Interface Driver. It implements the following interfaces:
BLE Proximity Profile Interface Framework on RL78G1D	RTOS-integrated BLE Proximity Profile Framework example. Implementation of RL78G1D BLE Proximity Profile Interface Driver. It implements the following interfaces:
BLE Scan Parameters Service Profile Interface Framework on RL78G1D	RTOS-integrated BLE Scan Parameters Service Profile Framework example. Implementation of RL78G1D BLE Scan Parameters Service Profile Interface Driver. It implements the following interfaces:
BLE Time Information Profile Interface Framework on RL78G1D	RTOS-integrated BLE Time Information Profile Framework example. Implementation of RL78G1D BLE Time Information Profile Interface Driver. It implements the following interfaces:
Cellular Framework Example using Quectel CATM1 API	SF_CELLULAR Framework API on Quectel CATM1
BSD Socket over Quectel CATM1 on-chip stack API	SF_CELLULAR Socket Framework API on Quectel CATM1
Cellular Framework Example using RYZ014CATM1 API	SF_CELLULAR Framework API on RYZ014CATM1
SF CELLULAR Common Interface	SF_Cellular Framework API Common Code
BSD Socket over RYZ014CATM1 on-chip stack API	SF_CELLULAR Socket Framework API on RYZ014CATM1
►Framework Layer
ADC periodic Framework	RTOS-integrated ADC Framework
Audio Framework	RTOS-integrated Audio Framework
DAC Audio Playback Framework	RTOS-integrated DAC implementation of Audio Playback Interface
I2S Audio Playback Framework	RTOS-integrated I2S implementation of Audio Playback Interface
ADC Audio recording Framework	RTOS-integrated ADC implementation of Audio Recording Interface
I2S Audio recording Framework	I2S implementation of Audio Recording Interface
BLOCK_MEDIA_LEVELX_NOR	RTOS-integrated Block Media framework for LEVELX driver
BLOCK_MEDIA_QSPI	RTOS-integrated Block Media framework for QSPI driver
BLOCK_MEDIA_RAM	RTOS-integrated Block Media framework for RAM
BLOCK_MEDIA_SDMMC	RTOS-integrated Block Media framework for SDMMC driver
Cellular NSAL Implementation on NetX	Cellular NetX NSAL interface implementation header file
Telnet Communication Framework on sf_comms_telnet	RTOS-integrated Communications Framework NetX telnet server implementation
Console Framework	RTOS-integrated Console Framework
SSP Crypto Common Framework	RTOS-integrated Crypto Common Framework Module
SSP Crypto Cipher Framework	RTOS-integrated Crypto Cipher Framework Module
SSP Crypto Hash Framework	RTOS-integrated Crypto HASH Framework Module
SSP Crypto Key Framework	RTOS-integrated Crypto Key Framework Module
SSP Crypto Key Installation Framework	RTOS-integrated Crypto Key Installation Framework Module
SSP Crypto Signature Framework	RTOS-integrated Crypto Signature Framework Module
SSP Crypto TRNG Framework	RTOS-integrated Crypto TRNG Framework Module
FX_IO Framework	FileX adaptation layer for block media device drivers
GUIX Synergy Port	GUIX adaptation layer
EL_LX_NOR	LevelX NOR driver implementation
USB Communication Framework V2	RTOS-integrated USBX CDC ACM device implementation
External IRQ Framework	RTOS-integrated external IRQ Framework
I2C Framework	RTOS-integrated I2C Framework
JPEG Framework	RTOS-integrated JPEG Framework
Memory framework	RTOS-integrated Memory framework for QSPI NOR driver
Messaging Framework	RTOS-integrated Messaging Framework implementation
Power Profiles Framework V2	Power Profiles Framework
SPI Framework	RTOS-integrated SPI Framework
Thread Monitor Framework	Framework module providing monitoring of threads
CTSU V2 Framework	CTSU V2 Framework
Touch Panel V2 Framework	RTOS-integrated touch panel V2 Framework implementation touch chips
UART Framework Instance	RTOS-integrated Communications Framework UART implementation
►NetX Synergy Port	RTOS-integrated NetX Ethernet driver for the Renesas Synergy software and Synergy Ethernet IP
Interface file between SF_EL_NX and PHY driver
NetX Synergy Port PHY Driver	Interface between SF_EL_NX Ethernet framework and PHY driver
BLE Framework on RL78G1D	RTOS-integrated BLE Framework example. Implementation of RL78G1D BLE Driver. It implements the following interfaces:
BLE On-Board Profile Framework on RL78G1D	RTOS-integrated BLE On-Board Profile Framework example. Implementation of RL78G1D BLE On-Board Profile Driver. It implements the following interfaces:
Cellular Framework Example using Quectel CATM1	RTOS-integrated Cellular Framework example. Implementation of Cellular Quectel CATM1 Driver. It implements the following interfaces:
BSD Socket over Quectel CATM1 on-chip stack	RTOS-integrated Cellular Socket Framework example. Implementation of Quectel CATM1 Socket layer over Quectel CATM1 On-Chip stack It implements the following interfaces:
Cellular Framework Example using RYZ014 CATM1	RTOS-integrated Cellular Framework example. Implementation of Cellular RYZ014 CATM1 Driver. It implements the following interfaces:
BSD Socket over RYZ014CATM1 on-chip stack	RTOS-integrated Cellular Socket Framework example. Implementation of RYZ014CATM1 Socket layer over RYZ014CATM1 On-Chip stack It implements the following interfaces:
Touch Panel Framework Example for FT5X06	RTOS-integrated touch panel chip ft5x06 example. Implementation of ft5x06 touch chip Driver. It implements the following interfaces:
Touch Panel Framework Example for SX8654	RTOS-integrated touch panel chip sx8654 example. Implementation of sx8654 touch chip Driver. It implements the following interfaces:
WiFi Framework on GT202	RTOS-integrated WiFi Framework example. Implementation of Atheros WiFi Driver. It implements the following interfaces:
WiFi On Chip Stack on GT202	RTOS-integrated WiFi On Chip Stack Framework example. Implementation of Atheros WiFi Driver. It implements the following interfaces:
BSD Socket on GT202	Implementation of GT202 Socket layer over GT202 On-Chip stack
WiFi Framework on QCA4010	RTOS-integrated WiFi Framework example. Implementation of Silex ULPGN WiFi Driver. It implements the following interfaces:
WiFi On Chip Stack on QCA4010	RTOS-integrated WiFi On Chip Stack Framework example. Implementation of SILEX WiFi Driver. It implements the following interfaces:
Socket on QCA4010	Implementation of QCA4010 Socket layer over QCA4010 On-Chip stack
USBX Framework	RTOS-integrated USBX adaptation framework for Synergy. Implements USB HOST and DEVICE low level device drivers
2D Drawing Engine Support Framework
►HAL Interfaces
ADC Interface	Interface for A/D Converters
Analog Connect Interface	Interface for analog connections
CAC Interface	Interface for clock frequency accuracy measurements
CAN Interface	Interface for CAN peripheral
CGC Interface	Interface for clock generation
COMPARATOR Interface	Interface for Comparators
CRC Interface	Interface for cyclic redundancy checking
CTSU v2 Interface	Interface for Capacitive Touch Controllers
DAC Interface	Interface for D/A converters
Display Interface	Interface for LCD panel displays
DOC Interface	Interface for the Data Operation Circuit
events and peripheral definitions	Interface for the Event Link Controller
External IRQ Interface	Interface for detecting external interrupts
Flash Interface	Interface for the flash controller
FMI Interface	Interface for reading on-chip factory information
I2C Interface	Interface for I2C communication
I2S Interface	The I2S (Inter-IC Sound) interface provides APIs and definitions for I2S audio communication
Input Capture Interface	Interface for sampling input signals for pulse width
I/O Port Interface	Interface for accessing I/O ports and configuring I/O functionality
JPEG Decode Interface	Interface for JPEG decode functions
JPEG Encode Interface	Interface for JPEG encode functions
Key Matrix Interface	Interface for key matrix functions
Low Power Modes V2 Interface	Interface for accessing low power modes
Low Voltage Detection Interface	This section defines the API for the LVD (Low Voltage Detection) Driver
OPAMP Interface	Interface for Operational Amplifiers
PDC Interface	Interface for PDC functions
PTP driver Interface	Interface for PTP functions
PTPEDMAC driver Interface	Interface for PTPEDMAC functions
Quad SPI Flash Interface	Interface for accessing external SPI flash devices
RTC Interface	Interface for accessing the Realtime Clock
SD/MMC Interface	Interface for accessing SD, eMMC, and SDIO devices
SLCDC Interface	Interface for Segment LCD controllers
SPI Interface	Interface for SPI communications
Timer Interface	Interface for timer functions
Transfer Interface	Interface for data transfer functions
UART Interface	Interface for UART communications
WDT Interface	Interface for watch dog timer functions
►HAL Layer
High-Speed Analog Comparator	Driver for the High-Speed Analog Comparator
Low Power Analog Comparator	Driver for the Low Power Analog Comparator
ADC	Driver for the 14-Bit A/D Converter (ADC14) and 12-bit A/D Converter (ADC12)
AGT	Driver for the Asynchronous General Purpose Timer (AGT)
AGT Input Capture	Driver for the Asynchronous General-Purpose Timer (AGT) with Input Capture
Analog Connections	Driver for internal analog connections
CAC	Driver for the Clock Frequency Accuracy Measurement Circuit (CAC)
CAN	Driver for CAN, Controller Area Network
CGC	Driver for the Clock Generation Circuit
CRC	Driver for the CRC Calculator (CRC)
CTSU v2	Driver for the Capacitive Touch Sensing Unit (CTSU)
DAC	Driver for the 12-Bit D/C Converter (DAC12)
DAC8	Driver for the 8-Bit D/C Converter (DAC8)
DMAC	DMA Controller (DMAC)
DOC	Driver for the Data Operation Circuit (DOC)
DTC	Driver for the Data Transfer Controller (DTC)
ELC	Driver for the Event Link Controller (ELC)
High-performance Flash	Driver for the High-performance Flash Memory (S7G2 and S5D9)
Low Power Flash	Driver for the Low power Flash Memory (S3A7 and S124)
FMI	Driver for accessing Factory MCU Information (FMI)
GLCDC	Driver for the Graphics LCD Controller (GLCDC)
GPT	Driver for the General PWM Timer (GPT)
GPT Input Capture	Driver for the General PWM Timer (GPT) with Input Capture
ICU	Driver for the Interrupt Controller Unit (ICU) External pin interrupts function
IOPORT	Driver for the I/O Ports
IWDT	Driver for the Independent Watchdog Timer (IWDT)
JPEG CODEC	Driver for the JPEG CODEC
JPEG ENCODE	Driver for the JPEG CODEC
Key Interrupts	Driver for the Key Interrupt Function
►LPMV2 S124	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S128	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S1JA	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S3A1	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S3A3	Driver for Low Power Modes
Build Time Configurations
LPMV2 S3A6	Driver for Low Power Modes
►LPMV2 S3A7	Driver for Low Power Modes
Build Time Configurations
LPMV2 S5D3	Driver for Low Power Modes
►LPMV2 S5D5	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S5D9	Driver for Low Power Modes
Build Time Configurations
►LPMV2 S7G2	Driver for Low Power Modes
Build Time Configurations
LVD	Driver for Low Voltage Detection
Operational Amplifier (OPAMP)	Driver for the Operational Amplifier (OPAMP)
PDC	Driver for the Parallel Data Capture Unit (PDC)
PTP	Driver for the Precision time protocol(PTP)
PTPEDMAC	DMA controller for PTP driver
QSPI	Driver for the Quad Serial Peripheral Interface (QSPI)
IIC	Driver for the I2C Bus Interface (IIC)
IIC Slave	Driver for the I2C Bus Slave Interface (IIC Slave)
SPI	Driver for the Serial Peripheral Interface (SPI)
RTC	Driver for the Realtime Clock (RTC)
Simple I2C on SCI	Driver for the Simple IIC on SCI
Simple SPI on SCI	Driver for the Simple SPI on SCI
UART on SCI	Driver for the UART on SCI
Sigma Delta ADC (SDADC)	Driver for the 24-bit Sigma Delta A/D Converter (SDADC)
SDMMC	Driver for the SD/MMC Host Interface (SDHI)
SLCDC	Driver for the Segment LCD Controller (SLCDC)
SSI	Driver for the Serial Sound Interface (SSI)
WDT	Driver for the Watchdog Timer (WDT)
▼Board Support Package	Common BSP includes
►Supported MCUs	Supported MCUs in this version of the BSP
►S124	Code that is common to S124 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S128	Code that is common to S128 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S1JA	Code that is common to S1JA MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S3A1	Code that is common to S3A1 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S3A3	Code that is common to S3A3 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S3A6	Code that is common to S3A6 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S3A7	Code that is common to S3A7 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S5D3	Code that is common to S5D3 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S5D5	Code that is common to S5D5 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S5D9	Code that is common to S5D9 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►S7G2	Code that is common to S7G2 MCUs
Analog Connections
Cache Functions
Clock Initialization
Hardware Locks
Module Start and Stop
ROM Registers
►Common BSP Code	Code common to all BSPs
Common BSP LED Code and Types	Common support for board LEDs
Compiler Support
Software Delay	Common function to implement a software delay
Error Checking
Module specific feature overrides
Grouped Interrupt Support
Interrupt Initialization
Atomic Locking
Register Protection
BSP_MCU_SBRK