![]() |
RA Flexible Software Package Documentation
Release v6.0.0
|
|
Driver for the I/O Ports peripheral on RA MCUs. This module implements the I/O Port Interface.
The I/O port pins operate as general I/O port pins, I/O pins for peripheral modules, interrupt input pins, analog I/O, port group function for the ELC, or bus control pins.
The IOPORT HAL module can configure the following pin settings:
The module also provides the following functionality:
The I/O PORT HAL module must be configured by the user for the desired operation. The operating state of an I/O pin can be set via the RA Configuration tool. When the project is built a pin configuration file is created. The BSP will automatically configure the MCU IO ports accordingly at startup using the same API functions mentioned in this document.
Configuration | Options | Default | Description |
---|---|---|---|
Parameter Checking |
| Default (BSP) | If selected code for parameter checking is included in the build. |
Configuration | Options | Default | Description |
---|---|---|---|
Name | Name must be a valid C symbol | g_ioport | Module name. |
1st Port ELC Trigger Source | MCU Specific Options | ELC source that will trigger the 1st port | |
2nd Port ELC Trigger Source | MCU Specific Options | ELC source that will trigger the 2nd port | |
3rd Port ELC Trigger Source | MCU Specific Options | ELC source that will trigger the 3rd port | |
4th Port ELC Trigger Source | MCU Specific Options | ELC source that will trigger the 4th port | |
Pin Configuration Name | Name must be a valid C symbol | g_bsp_pin_cfg | Name for pin configuration structure |
The I/O PORT HAL module does not require a specific clock configuration.
The IOPORT module is used for configuring pins.
Depending on pin configuration, the IOPORT module can perform automatic reads and writes on 4 ports (RA2 and RA0 series support 2 ports only, see the table of ELC triggers below) on receipt of an ELC event.
ELC triggers | RA6T2 | RA2XX, RA0XX | All others |
---|---|---|---|
1st Port | Port B | Port 1 | Port 1 |
2nd Port | Port C | Port 2 | Port 2 |
3rd Port | Port D | NA | Port 3 |
4th Port | Port E | NA | Port 4 |
When an event is received by a port, the state of the input pins on the port is saved in a hardware register. Simultaneously, the state of output pins on the port is set or cleared based on settings configured by the user. The functions R_IOPORT_PinEventInputRead and R_IOPORT_PortEventInputRead allow reading the last event input state of a pin or port, and event-triggered pin output can be configured through R_IOPORT_PinEventOutputWrite and R_IOPORT_PortEventOutputWrite.
In addition, each pin on these ports can be configured to trigger an ELC event on rising, falling or both edges. This event can be used to activate other modules when the pin changes state.
This is a basic example of minimal use of the IOPORT in an application.
This example uses IOPORT to configure and toggle a pin to blink an LED.
This is an example of using IOPORT with ELC events. The ELC event system allows the captured data to be stored when it occurs and then read back at a later time.
Data Structures | |
struct | ioport_instance_ctrl_t |
Enumerations | |
enum | ioport_port_pin_t |
enum | ioport_peripheral_t |
enum | ioport_cfg_options_t |
struct ioport_instance_ctrl_t |
IOPORT private control block. DO NOT MODIFY. Initialization occurs when R_IOPORT_Open() is called.
enum ioport_port_pin_t |
Superset list of all possible IO port pins.
enum ioport_peripheral_t |
Superset of all peripheral functions.
enum ioport_cfg_options_t |
Options to configure pin functions
fsp_err_t R_IOPORT_Open | ( | ioport_ctrl_t *const | p_ctrl, |
const ioport_cfg_t * | p_cfg | ||
) |
Initializes internal driver data, then calls pin configuration function to configure pins.
FSP_SUCCESS | Pin configuration data written to PFS register(s) |
FSP_ERR_ASSERTION | NULL pointer |
FSP_ERR_ALREADY_OPEN | Module is already open. |
fsp_err_t R_IOPORT_Close | ( | ioport_ctrl_t *const | p_ctrl | ) |
Resets IOPORT registers. Implements ioport_api_t::close
FSP_SUCCESS | The IOPORT was successfully uninitialized |
FSP_ERR_ASSERTION | p_ctrl was NULL |
FSP_ERR_NOT_OPEN | The module has not been opened |
fsp_err_t R_IOPORT_PinsCfg | ( | ioport_ctrl_t *const | p_ctrl, |
const ioport_cfg_t * | p_cfg | ||
) |
Configures the functions of multiple pins by loading configuration data into pin PFS registers. Implements ioport_api_t::pinsCfg.
This function initializes the supplied list of PmnPFS registers with the supplied values. This data can be generated by the Pins tab of the RA Configuration editor or manually by the developer. Different pin configurations can be loaded for different situations such as low power modes and testing.
FSP_SUCCESS | Pin configuration data written to PFS register(s) |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PinCfg | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_pin_t | pin, | ||
uint32_t | cfg | ||
) |
Configures the settings of a pin. Implements ioport_api_t::pinCfg.
FSP_SUCCESS | Pin configured |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PinRead | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_pin_t | pin, | ||
bsp_io_level_t * | p_pin_value | ||
) |
Reads the level on a pin. Implements ioport_api_t::pinRead.
FSP_SUCCESS | Pin read |
FSP_ERR_ASSERTION | NULL pointer |
FSP_ERR_NOT_OPEN | The module has not been opened |
fsp_err_t R_IOPORT_PortRead | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_t | port, | ||
ioport_size_t * | p_port_value | ||
) |
Reads the value on an IO port. Implements ioport_api_t::portRead.
The specified port will be read, and the levels for all the pins will be returned. Each bit in the returned value corresponds to a pin on the port. For example, bit 7 corresponds to pin 7, bit 6 to pin 6, and so on.
FSP_SUCCESS | Port read |
FSP_ERR_ASSERTION | NULL pointer |
FSP_ERR_NOT_OPEN | The module has not been opened |
fsp_err_t R_IOPORT_PortWrite | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_t | port, | ||
ioport_size_t | value, | ||
ioport_size_t | mask | ||
) |
Writes to multiple pins on a port. Implements ioport_api_t::portWrite.
The input value will be written to the specified port. Each bit in the value parameter corresponds to a bit on the port. For example, bit 7 corresponds to pin 7, bit 6 to pin 6, and so on. Each bit in the mask parameter corresponds to a pin on the port.
Only the bits with the corresponding bit in the mask value set will be updated. For example, value = 0xFFFF, mask = 0x0003 results in only bits 0 and 1 being updated.
FSP_SUCCESS | Port written to |
FSP_ERR_INVALID_ARGUMENT | The port and/or mask not valid |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PinWrite | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_pin_t | pin, | ||
bsp_io_level_t | level | ||
) |
Sets a pin's output either high or low. Implements ioport_api_t::pinWrite.
FSP_SUCCESS | Pin written to |
FSP_ERR_INVALID_ARGUMENT | The pin and/or level not valid |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PortDirectionSet | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_t | port, | ||
ioport_size_t | direction_values, | ||
ioport_size_t | mask | ||
) |
Sets the direction of individual pins on a port. Implements ioport_api_t::portDirectionSet().
Multiple pins on a port can be set to inputs or outputs at once. Each bit in the mask parameter corresponds to a pin on the port. For example, bit 7 corresponds to pin 7, bit 6 to pin 6, and so on. If a bit is set to 1 then the corresponding pin will be changed to an input or an output as specified by the direction values. If a mask bit is set to 0 then the direction of the pin will not be changed.
FSP_SUCCESS | Port direction updated |
FSP_ERR_INVALID_ARGUMENT | The port and/or mask not valid |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PortEventInputRead | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_t | port, | ||
ioport_size_t * | p_event_data | ||
) |
Reads the value of the event input data. Implements ioport_api_t::portEventInputRead().
The event input data for the port will be read. Each bit in the returned value corresponds to a pin on the port. For example, bit 7 corresponds to pin 7, bit 6 to pin 6, and so on.
The port event data is captured in response to a trigger from the ELC. This function enables this data to be read. Using the event system allows the captured data to be stored when it occurs and then read back at a later time.
FSP_SUCCESS | Port read |
FSP_ERR_INVALID_ARGUMENT | Port not a valid ELC port |
FSP_ERR_ASSERTION | NULL pointer |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_UNSUPPORTED | Function not supported. |
fsp_err_t R_IOPORT_PinEventInputRead | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_pin_t | pin, | ||
bsp_io_level_t * | p_pin_event | ||
) |
Reads the value of the event input data of a specific pin. Implements ioport_api_t::pinEventInputRead.
The pin event data is captured in response to a trigger from the ELC. This function enables this data to be read. Using the event system allows the captured data to be stored when it occurs and then read back at a later time.
FSP_SUCCESS | Pin read |
FSP_ERR_ASSERTION | NULL pointer |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_INVALID_ARGUMENT | Port is not valid ELC PORT. |
FSP_ERR_UNSUPPORTED | Function not supported. |
fsp_err_t R_IOPORT_PortEventOutputWrite | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_t | port, | ||
ioport_size_t | event_data, | ||
ioport_size_t | mask_value | ||
) |
This function writes the set and reset event output data for a port. Implements ioport_api_t::portEventOutputWrite.
Using the event system enables a port state to be stored by this function in advance of being output on the port. The output to the port will occur when the ELC event occurs.
The input value will be written to the specified port when an ELC event configured for that port occurs. Each bit in the value parameter corresponds to a bit on the port. For example, bit 7 corresponds to pin 7, bit 6 to pin 6, and so on. Each bit in the mask parameter corresponds to a pin on the port.
FSP_SUCCESS | Port event data written |
FSP_ERR_INVALID_ARGUMENT | Port or Mask not valid |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |
fsp_err_t R_IOPORT_PinEventOutputWrite | ( | ioport_ctrl_t *const | p_ctrl, |
bsp_io_port_pin_t | pin, | ||
bsp_io_level_t | pin_value | ||
) |
This function writes the event output data value to a pin. Implements ioport_api_t::pinEventOutputWrite.
Using the event system enables a pin state to be stored by this function in advance of being output on the pin. The output to the pin will occur when the ELC event occurs.
FSP_SUCCESS | Pin event data written |
FSP_ERR_INVALID_ARGUMENT | Port or Pin or value not valid |
FSP_ERR_NOT_OPEN | The module has not been opened |
FSP_ERR_ASSERTION | NULL pointer |