### Port Output Enable 3 for MTU3 (r_poe3) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages Port Output Enable signals for the MTU3 timer, often used for PWM generation. ```APIDOC ## PUT /api/poe3/channel/enable ### Description Enables or disables the Port Output Enable signal for a specific MTU3 channel. ### Method PUT ### Endpoint /api/poe3/channel/enable ### Parameters #### Request Body - **channel** (string) - Required - The MTU3 channel identifier (e.g., "MTU3_CH0"). - **enable** (boolean) - Required - True to enable the output, false to disable. ### Request Example ```json { "channel": "MTU3_CH2", "enable": true } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "Port output for MTU3 channel MTU3_CH2 enabled." } ``` ``` -------------------------------- ### I/O Port (r_ioport) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages the configuration and control of General Purpose Input/Output (GPIO) ports. ```APIDOC ## POST /api/ioport/pin/configure ### Description Configures a specific I/O port pin's direction, drive strength, and pull-up/down resistors. ### Method POST ### Endpoint /api/ioport/pin/configure ### Parameters #### Request Body - **pin_name** (string) - Required - The name or identifier of the I/O pin (e.g., "P1_0"). - **direction** (string) - Required - The pin direction: "input" or "output". - **drive_strength** (string) - Optional - The drive strength setting (e.g., "medium", "high"). - **pull_resistance** (string) - Optional - Pull resistor setting: "none", "pull-up", "pull-down". ### Request Example ```json { "pin_name": "P3_2", "direction": "output", "drive_strength": "high", "pull_resistance": "none" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message indicating successful configuration. #### Response Example ```json { "status": "Pin P3_2 configured successfully." } ``` ``` ```APIDOC ## PUT /api/ioport/pin/state ### Description Sets the output state (high or low) for a configured output I/O pin. ### Method PUT ### Endpoint /api/ioport/pin/state ### Parameters #### Request Body - **pin_name** (string) - Required - The name or identifier of the I/O pin. - **state** (string) - Required - The desired state: "high" or "low". ### Request Example ```json { "pin_name": "P1_5", "state": "high" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message indicating successful state change. #### Response Example ```json { "status": "Pin P1_5 set to high." } ``` ``` ```APIDOC ## GET /api/ioport/pin/state ### Description Reads the current input state of an I/O pin. ### Method GET ### Endpoint /api/ioport/pin/state ### Parameters #### Query Parameters - **pin_name** (string) - Required - The name or identifier of the I/O pin. ### Response #### Success Response (200) - **state** (string) - The current state of the input pin: "high" or "low". #### Response Example ```json { "state": "low" } ``` ``` -------------------------------- ### SDRAM (r_bsc_sdram) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Interface for controlling and managing Synchronous Dynamic Random-Access Memory (SDRAM) using the BSC controller. ```APIDOC ## POST /api/sdram/configure ### Description Configures the SDRAM controller with specified timing and configuration parameters. ### Method POST ### Endpoint /api/sdram/configure ### Parameters #### Request Body - **timing_parameters** (object) - Required - SDRAM timing configurations. - **t_rcd** (integer) - Required - RAS to CAS delay. - **t_rp** (integer) - Required - Row precharge time. - **t_ras** (integer) - Required - Row active time. - **capacity** (integer) - Required - Total SDRAM capacity in bytes. ### Request Example ```json { "timing_parameters": { "t_rcd": 2, "t_rp": 2, "t_ras": 5 }, "capacity": 67108864 } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the configuration was successful. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### Memory Configuration Check Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Performs checks on the memory configuration to ensure integrity and compatibility. ```APIDOC ## GET /api/memory/config/check ### Description Initiates a check of the system's memory configuration. ### Method GET ### Endpoint /api/memory/config/check ### Response #### Success Response (200) - **is_valid** (boolean) - True if the memory configuration is valid, false otherwise. - **details** (string) - Provides details about the configuration check result. #### Response Example ```json { "is_valid": true, "details": "Memory configuration verified successfully." } ``` ``` -------------------------------- ### Transfer (r_dmac) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages Direct Memory Access Controller (DMAC) for efficient data transfers between peripherals and memory. ```APIDOC ## POST /api/dmac/transfer/start ### Description Initiates a data transfer using the Direct Memory Access Controller (DMAC). ### Method POST ### Endpoint /api/dmac/transfer/start ### Parameters #### Request Body - **dmac_channel** (string) - Required - The DMAC channel identifier (e.g., "DMAC0_CH0"). - **source_address** (string) - Required - The starting address of the source data. - **destination_address** (string) - Required - The starting address of the destination. - **transfer_size** (integer) - Required - The total number of bytes to transfer. - **transfer_mode** (string) - Optional - The transfer mode (e.g., "byte", "halfword", "word"). Defaults to "word". ### Request Example ```json { "dmac_channel": "DMAC1_CH3", "source_address": "0x10000000", "destination_address": "0x20000000", "transfer_size": 1024, "transfer_mode": "byte" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message indicating the transfer has started. #### Response Example ```json { "status": "DMAC1_CH3 transfer initiated." } ``` ``` ```APIDOC ## GET /api/dmac/transfer/status ### Description Retrieves the status of an ongoing or completed DMAC transfer. ### Method GET ### Endpoint /api/dmac/transfer/status ### Parameters #### Query Parameters - **dmac_channel** (string) - Required - The DMAC channel identifier. ### Response #### Success Response (200) - **status** (string) - The current status of the transfer (e.g., "idle", "in_progress", "complete", "error"). - **bytes_transferred** (integer) - The number of bytes transferred so far. #### Response Example ```json { "status": "in_progress", "bytes_transferred": 512 } ``` ``` -------------------------------- ### Event Link Controller (r_elc) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Configures and manages the Event Link Controller (ELC) for inter-module event routing. ```APIDOC ## POST /api/elc/link ### Description Establishes a link between two events using the Event Link Controller. ### Method POST ### Endpoint /api/elc/link ### Parameters #### Request Body - **source_event** (string) - Required - The identifier of the source event. - **destination_event** (string) - Required - The identifier of the destination event. ### Request Example ```json { "source_event": "GPT0_COUNTER_UNDERFLOW", "destination_event": "DMAC0_TRANSFER_COMPLETE" } ``` ### Response #### Success Response (200) - **link_id** (string) - A unique identifier for the established link. #### Response Example ```json { "link_id": "e1a2b3c4d5e6f7a8" } ``` ``` -------------------------------- ### Three-Phase PWM (r_mtu3_three_phase) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Generates three-phase PWM signals using the MTU3 timer module. ```APIDOC ## POST /api/mtu3/three_phase/set_duty ### Description Sets the duty cycles for the three phases of PWM output generated by MTU3. ### Method POST ### Endpoint /api/mtu3/three_phase/set_duty ### Parameters #### Request Body - **mtu3_channel_group** (string) - Required - The MTU3 channel group identifier (e.g., "MTU3_CH0_CH1_CH2"). - **duty_cycle_a** (float) - Required - Duty cycle for phase A (0.0 to 1.0). - **duty_cycle_b** (float) - Required - Duty cycle for phase B (0.0 to 1.0). - **duty_cycle_c** (float) - Required - Duty cycle for phase C (0.0 to 1.0). ### Request Example ```json { "mtu3_channel_group": "MTU3_CH0_CH1_CH2", "duty_cycle_a": 0.3, "duty_cycle_b": 0.6, "duty_cycle_c": 0.9 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "Duty cycles updated for MTU3 channel group." } ``` ``` -------------------------------- ### Timer, General PWM (r_gpt) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Provides functionality for generating General Purpose PWM (Pulse Width Modulation) signals using GPT timers. ```APIDOC ## POST /api/gpt/channel/pwm ### Description Configures a GPT channel to operate in PWM mode and sets its duty cycle. ### Method POST ### Endpoint /api/gpt/channel/pwm ### Parameters #### Request Body - **gpt_channel** (string) - Required - The GPT channel identifier (e.g., "GPT0_CH0"). - **frequency_hz** (integer) - Required - The PWM frequency in Hertz. - **duty_cycle_percent** (float) - Required - The PWM duty cycle as a percentage (0.0 to 100.0). ### Request Example ```json { "gpt_channel": "GPT2_CH1", "frequency_hz": 10000, "duty_cycle_percent": 75.0 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "GPT2_CH1 configured for PWM at 10kHz with 75% duty cycle." } ``` ``` -------------------------------- ### Port Output Enable for GPT (r_poeg) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Controls the Port Output Enable signals for General PWM Timer (GPT) modules. ```APIDOC ## POST /api/poeg/output/configure ### Description Configures the output enable for a GPT channel. ### Method POST ### Endpoint /api/poeg/output/configure ### Parameters #### Request Body - **gpt_channel** (string) - Required - The GPT channel identifier (e.g., "GPT0_CH0"). - **output_enable_pin** (string) - Required - The GPIO pin associated with the output enable signal. - **active_level** (string) - Optional - The logic level that enables the output (e.g., "high", "low"). Defaults to "high". ### Request Example ```json { "gpt_channel": "GPT1_CH3", "output_enable_pin": "P5_1", "active_level": "low" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "GPT output enable configured for GPT1_CH3 on P5_1." } ``` ``` -------------------------------- ### Shared Memory Driver (r_shared_memory) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Provides mechanisms for safe and efficient data sharing between different processing units or cores. ```APIDOC ## POST /api/shared_memory/write ### Description Writes data to a shared memory region. ### Method POST ### Endpoint /api/shared_memory/write ### Parameters #### Request Body - **region_id** (string) - Required - Identifier for the shared memory region. - **data** (string) - Required - The data to write (e.g., JSON string, base64 encoded). ### Request Example ```json { "region_id": "shared_data_buffer", "data": "{\"message\": \"Hello from CPU0\"}" } ``` ### Response #### Success Response (200) - **bytes_written** (integer) - The number of bytes successfully written. #### Response Example ```json { "bytes_written": 25 } ``` ``` ```APIDOC ## GET /api/shared_memory/read ### Description Reads data from a shared memory region. ### Method GET ### Endpoint /api/shared_memory/read ### Parameters #### Query Parameters - **region_id** (string) - Required - Identifier for the shared memory region. - **bytes_to_read** (integer) - Optional - The number of bytes to read. ### Response #### Success Response (200) - **data** (string) - The data read from the shared memory region. #### Response Example ```json { "data": "{\"message\": \"Hello from CPU0\"}" } ``` ``` -------------------------------- ### DSMIF Channel Configuration (r_dsmif) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Configures the Digital Sigma-Delta Modulator Interface (DSMIF) channels. ```text ``` -------------------------------- ### Timer, Compare Match W (r_cmtw) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages the Compare Match Timer W (CMTW), a wider-range timer for longer interval measurements. ```APIDOC ## POST /api/cmtw/configure ### Description Configures the Compare Match Timer W (CMTW) with a specific compare value. ### Method POST ### Endpoint /api/cmtw/configure ### Parameters #### Request Body - **cmtw_channel** (string) - Required - The CMTW channel identifier (e.g., "CMTW0"). - **compare_value** (integer) - Required - The value to compare against the timer count. - **mode** (string) - Optional - The operating mode (e.g., "periodic", "one_shot"). Defaults to "periodic". ### Request Example ```json { "cmtw_channel": "CMTW0", "compare_value": 65535, "mode": "periodic" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "CMTW0 configured with compare value 65535." } ``` ``` -------------------------------- ### SD/MMC (r_sdhi) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Provides an interface for Secure Digital (SD) and MultiMediaCard (MMC) storage devices. ```APIDOC ## GET /api/sdhi ### Description Retrieves information or status related to the SD/MMC interface. ### Method GET ### Endpoint /api/sdhi ### Parameters #### Query Parameters - **card_type** (string) - Optional - Specifies the type of card (SD or MMC). ### Response #### Success Response (200) - **status** (string) - The current status of the SD/MMC interface. - **card_detected** (boolean) - Indicates if a card is currently detected. #### Response Example ```json { "status": "initialized", "card_detected": true } ``` ``` -------------------------------- ### Clock Generation Circuit (r_cgc) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages the clock generation circuits, allowing control over system clocks and frequencies. ```APIDOC ## PUT /api/cgc/clock ### Description Updates the system clock frequency and configuration. ### Method PUT ### Endpoint /api/cgc/clock ### Parameters #### Query Parameters - **frequency_hz** (integer) - Required - The desired clock frequency in Hertz. - **source** (string) - Optional - The clock source (e.g., "HOCO", "SOSCO"). ### Response #### Success Response (200) - **current_frequency_hz** (integer) - The currently active clock frequency. #### Response Example ```json { "current_frequency_hz": 100000000 } ``` ``` -------------------------------- ### Timer, Multi-Function Timer Pulse Unit 3 (r_mtu3) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Provides detailed control over the Multi-Function Timer Pulse Unit 3 (MTU3) for various timing applications. ```APIDOC ## PUT /api/mtu3/channel/mode ### Description Configures the operating mode for a specific MTU3 channel. ### Method PUT ### Endpoint /api/mtu3/channel/mode ### Parameters #### Request Body - **channel** (string) - Required - The MTU3 channel identifier (e.g., "MTU3_CH3"). - **mode** (string) - Required - The operating mode (e.g., "pwm", "capture", "one_shot"). ### Request Example ```json { "channel": "MTU3_CH4", "mode": "capture" } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "MTU3 channel MTU3_CH4 set to capture mode." } ``` ``` -------------------------------- ### Realtime Clock (r_rtc) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Provides access to the Real-Time Clock (RTC) for timekeeping functionalities. ```APIDOC ## GET /api/rtc/time ### Description Retrieves the current time from the Real-Time Clock. ### Method GET ### Endpoint /api/rtc/time ### Response #### Success Response (200) - **year** (integer) - The current year. - **month** (integer) - The current month (1-12). - **day** (integer) - The current day of the month (1-31). - **hour** (integer) - The current hour (0-23). - **minute** (integer) - The current minute (0-59). - **second** (integer) - The current second (0-59). #### Response Example ```json { "year": 2023, "month": 10, "day": 27, "hour": 14, "minute": 30, "second": 0 } ``` ``` ```APIDOC ## PUT /api/rtc/time ### Description Sets the current time for the Real-Time Clock. ### Method PUT ### Endpoint /api/rtc/time ### Parameters #### Request Body - **year** (integer) - Required - The year to set. - **month** (integer) - Required - The month to set (1-12). - **day** (integer) - Required - The day to set (1-31). - **hour** (integer) - Required - The hour to set (0-23). - **minute** (integer) - Required - The minute to set (0-59). - **second** (integer) - Required - The second to set (0-59). ### Request Example ```json { "year": 2023, "month": 10, "day": 27, "hour": 14, "minute": 35, "second": 15 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "RTC time updated successfully." } ``` ``` -------------------------------- ### ERROR (r_icu_error) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Handles interrupt controller error reporting and management. ```APIDOC ## GET /api/icu/error ### Description Retrieves the status of interrupt controller errors. ### Method GET ### Endpoint /api/icu/error ### Response #### Success Response (200) - **error_code** (integer) - A code representing the current error status. - **error_message** (string) - A human-readable description of the error. #### Response Example ```json { "error_code": 0, "error_message": "No errors detected." } ``` ``` -------------------------------- ### Three-Phase PWM (r_gpt_three_phase) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Generates three-phase Pulse Width Modulation (PWM) signals using the GPT timer. ```APIDOC ## POST /api/gpt/three_phase/configure ### Description Configures the GPT timer for three-phase PWM output. ### Method POST ### Endpoint /api/gpt/three_phase/configure ### Parameters #### Request Body - **gpt_instance** (string) - Required - The GPT instance to use (e.g., "GPT0"). - **frequency_hz** (integer) - Required - The PWM frequency in Hertz. - **duty_cycle_a** (float) - Required - Duty cycle for phase A (0.0 to 1.0). - **duty_cycle_b** (float) - Required - Duty cycle for phase B (0.0 to 1.0). - **duty_cycle_c** (float) - Required - Duty cycle for phase C (0.0 to 1.0). ### Request Example ```json { "gpt_instance": "GPT1", "frequency_hz": 20000, "duty_cycle_a": 0.5, "duty_cycle_b": 0.5, "duty_cycle_c": 0.5 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "GPT1 configured for 3-phase PWM at 20kHz." } ``` ``` -------------------------------- ### Timer, Compare Match (r_cmt) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Utilizes the Compare Match Timer (CMT) for generating periodic interrupts or timing events. ```APIDOC ## POST /api/cmt/start ### Description Starts a Compare Match Timer (CMT) with a specified period. ### Method POST ### Endpoint /api/cmt/start ### Parameters #### Request Body - **cmt_channel** (string) - Required - The CMT channel identifier (e.g., "CMT0"). - **period_ms** (integer) - Required - The timer period in milliseconds. ### Request Example ```json { "cmt_channel": "CMT1", "period_ms": 100 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "CMT1 started with a 100ms period." } ``` ``` ```APIDOC ## DELETE /api/cmt/stop ### Description Stops a running Compare Match Timer (CMT). ### Method DELETE ### Endpoint /api/cmt/stop ### Parameters #### Query Parameters - **cmt_channel** (string) - Required - The CMT channel identifier to stop. ### Response #### Success Response (200) - **status** (string) - Confirmation message. #### Response Example ```json { "status": "CMT1 stopped." } ``` ``` -------------------------------- ### Inter-CPU IRQ (r_icu_inter_cpu_irq) Source: https://github.com/renesas/rzn-fsp/blob/master/SUPPORTED_SOFTWARE.md Manages interrupt requests between different CPUs within a multi-core system. ```APIDOC ## POST /api/icu/intercpu/interrupt ### Description Sends an interrupt request from one CPU to another. ### Method POST ### Endpoint /api/icu/intercpu/interrupt ### Parameters #### Request Body - **target_cpu_id** (integer) - Required - The identifier of the target CPU. - **interrupt_vector** (integer) - Required - The interrupt vector number to trigger. ### Request Example ```json { "target_cpu_id": 1, "interrupt_vector": 10 } ``` ### Response #### Success Response (200) - **status** (string) - Confirmation message indicating the interrupt was sent. #### Response Example ```json { "status": "Interrupt sent to CPU 1 on vector 10." } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.