|
Zephyr API Documentation 4.3.0-rc1
A Scalable Open Source RTOS
|
Interfaces for Renesas Event Link Controller (ELC). More...
Files | |
| file | renesas_elc.h |
| Public APIs for the Renesas ELC driver. | |
Data Structures | |
| struct | renesas_elc_dt_spec |
| Container for Renesas ELC information specified in devicetree. More... | |
Macros | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_NAME(node_id, name) |
| Get the device pointer from the "renesas-elcs" property by element name. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_IDX(node_id, idx) |
| Get the device pointer from the "renesas-elcs" property by index. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_NAME_OR_NULL(node_id, name) |
| Get the device pointer from the "renesas-elcs" property by element name, or return NULL if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_IDX_OR_NULL(node_id, idx) |
| Get the device pointer from the "renesas-elcs" property by index, or return NULL if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_NAME(inst, name) |
| Get the device pointer from the "renesas-elcs" property by element name for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_IDX(inst, idx) |
| Get the device pointer from the "renesas-elcs" property by index for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_NAME_OR_NULL(inst, name) |
| Get the device pointer from the "renesas-elcs" property by element name for a DT_DRV_COMPAT instance, or return NULL if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_IDX_OR_NULL(inst, idx) |
| Get the device pointer from the "renesas-elcs" property by index for a DT_DRV_COMPAT instance, or return NULL if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_NAME(node_id, name) |
| Get the peripheral cell value from the "renesas-elcs" property by element name. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_IDX(node_id, idx) |
| Get the peripheral cell value from the "renesas-elcs" property by index. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_NAME_OR(node_id, name, default_value) |
| Get the peripheral cell value from the "renesas-elcs" property by element name, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_IDX_OR(node_id, idx, default_value) |
| Get the peripheral cell value from the "renesas-elcs" property by index, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_NAME(inst, name) |
| Get the peripheral cell value by element name for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_IDX(inst, idx) |
| Get the peripheral cell value by index for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_NAME_OR(inst, name, default_value) |
| Get the peripheral cell value by element name for a DT_DRV_COMPAT instance, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_IDX_OR(inst, idx, default_value) |
| Get the peripheral cell value by index for a DT_DRV_COMPAT instance, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_GET_BY_NAME(node_id, name) |
| Get the event cell value from the "renesas-elcs" property by element name. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_GET_BY_IDX(node_id, idx) |
| Get the event cell value from the "renesas-elcs" property by index. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_GET_BY_NAME_OR(node_id, name, default_value) |
| Get the event cell value from the "renesas-elcs" property by element name, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_GET_BY_IDX_OR(node_id, idx, default_value) |
| Get the event cell value from the "renesas-elcs" property by index, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_NAME(inst, name) |
| Get the event cell value by element name for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_IDX(inst, idx) |
| Get the event cell value by index for a DT_DRV_COMPAT instance. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_NAME_OR(inst, name, default_value) |
| Get the event cell value by element name for a DT_DRV_COMPAT instance, or return a default value if the property does not exist. | |
| #define | RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_IDX_OR(inst, idx, default_value) |
| Get the event cell value by index for a DT_DRV_COMPAT instance, or return a default value if the property does not exist. | |
Functions | |
| int | renesas_elc_software_event_generate (const struct device *dev, uint32_t event) |
| Generate a software event in the Event Link Controller. | |
| int | renesas_elc_link_set (const struct device *dev, uint32_t peripheral, uint32_t event) |
| Create a single event link. | |
| int | renesas_elc_link_break (const struct device *dev, uint32_t peripheral) |
| Break an event link. | |
| int | renesas_elc_enable (const struct device *dev) |
| Enable the operation of the Event Link Controller. | |
| int | renesas_elc_disable (const struct device *dev) |
| Disable the operation of the Event Link Controller. | |
Interfaces for Renesas Event Link Controller (ELC).
| #define RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_IDX | ( | node_id, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by index.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_IDX_OR_NULL | ( | node_id, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by index, or return NULL if the property does not exist.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_NAME | ( | node_id, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by element name.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_GET_BY_NAME_OR_NULL | ( | node_id, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by element name, or return NULL if the property does not exist.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_IDX | ( | inst, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by index for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_IDX_OR_NULL | ( | inst, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by index for a DT_DRV_COMPAT instance, or return NULL if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_NAME | ( | inst, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by element name for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_DEVICE_INST_GET_BY_NAME_OR_NULL | ( | inst, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the device pointer from the "renesas-elcs" property by element name for a DT_DRV_COMPAT instance, or return NULL if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_EVENT_GET_BY_IDX | ( | node_id, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value from the "renesas-elcs" property by index.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_EVENT_GET_BY_IDX_OR | ( | node_id, | |
| idx, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value from the "renesas-elcs" property by index, or return a default value if the property does not exist.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_EVENT_GET_BY_NAME | ( | node_id, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value from the "renesas-elcs" property by element name.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_EVENT_GET_BY_NAME_OR | ( | node_id, | |
| name, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value from the "renesas-elcs" property by element name, or return a default value if the property does not exist.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_IDX | ( | inst, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value by index for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_IDX_OR | ( | inst, | |
| idx, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value by index for a DT_DRV_COMPAT instance, or return a default value if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_NAME | ( | inst, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value by element name for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_EVENT_INST_GET_BY_NAME_OR | ( | inst, | |
| name, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the event cell value by element name for a DT_DRV_COMPAT instance, or return a default value if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_IDX | ( | node_id, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value from the "renesas-elcs" property by index.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_IDX_OR | ( | node_id, | |
| idx, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value from the "renesas-elcs" property by index, or return a default value if the property does not exist.
| node_id | Devicetree node identifier. |
| idx | Logical index into the renesas-elcs property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_NAME | ( | node_id, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value from the "renesas-elcs" property by element name.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_GET_BY_NAME_OR | ( | node_id, | |
| name, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value from the "renesas-elcs" property by element name, or return a default value if the property does not exist.
| node_id | Devicetree node identifier. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_IDX | ( | inst, | |
| idx ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value by index for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_IDX_OR | ( | inst, | |
| idx, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value by index for a DT_DRV_COMPAT instance, or return a default value if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| idx | Logical index into the renesas-elcs property. |
| default_value | Value to return if the property is not present. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_NAME | ( | inst, | |
| name ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value by element name for a DT_DRV_COMPAT instance.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| #define RENESAS_ELC_DT_SPEC_PERIPHERAL_INST_GET_BY_NAME_OR | ( | inst, | |
| name, | |||
| default_value ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Get the peripheral cell value by element name for a DT_DRV_COMPAT instance, or return a default value if the property does not exist.
| inst | DT_DRV_COMPAT instance number. |
| name | Lowercase-and-underscores name as specified in the renesas-elcs-names property. |
| default_value | Value to return if the property is not present. |
| int renesas_elc_disable | ( | const struct device * | dev | ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Disable the operation of the Event Link Controller.
This function disables the ELC, stopping event processing.
| dev | Event Link Controller device. |
| int renesas_elc_enable | ( | const struct device * | dev | ) |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Enable the operation of the Event Link Controller.
This function enables the ELC so that it can process events.
| dev | Event Link Controller device. |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Break an event link.
This function breaks an existing event link for the given peripheral.
| dev | Event Link Controller device. |
| peripheral | Peripheral ID whose link is to be broken. |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Create a single event link.
This function configures an event link by associating a peripheral with a specific event signal.
| dev | Event Link Controller device. |
| peripheral | Peripheral ID to be linked to the event signal. |
| event | Event signal ID to be associated with the peripheral. |
#include <zephyr/drivers/misc/interconn/renesas_elc/renesas_elc.h>
Generate a software event in the Event Link Controller.
This function requests the Renesas ELC to generate a software event identified by event.
| dev | The Event Link Controller device. |
| event | Software event ID to generate. |