ra8-firmware/ra8__mstp_8h_source.html

#pragma once


#ifdef __cplusplus

extern "C" {

#endif


#include <stdint.h>


#include "ra8_err.h"

#include "ra8_mstp_regs.h"


/* =============================================================================

 * Module-level lifecycle

 * =============================================================================

 */


[[nodiscard]] ra8_err_t ra8_mstp_init(void);


/* =============================================================================

 * Per-peripheral enable / disable

 * =============================================================================

 */


[[nodiscard]] ra8_err_t ra8_mstp_enable(ra8_mstp_t id);


[[nodiscard]] ra8_err_t ra8_mstp_disable(ra8_mstp_t id);


[[nodiscard]] ra8_err_t ra8_mstp_get_refcount(ra8_mstp_t id, uint8_t* out_ref);


[[nodiscard]] ra8_err_t ra8_mstp_is_stopped(ra8_mstp_t id, bool* out_stopped);


#ifdef __cplusplus

}

#endif

ra8_err.h
Error Code Definitions for ra8-firmware.

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

ra8_mstp_enable
ra8_err_t ra8_mstp_enable(ra8_mstp_t id)
Reference-counted "ungate this peripheral" request.
Definition ra8_mstp.c:343

ra8_mstp_is_stopped
ra8_err_t ra8_mstp_is_stopped(ra8_mstp_t id, bool *out_stopped)
Read the current MSTP bit value for an id.
Definition ra8_mstp.c:432

ra8_mstp_get_refcount
ra8_err_t ra8_mstp_get_refcount(ra8_mstp_t id, uint8_t *out_ref)
Read the current ref count for an MSTP id.
Definition ra8_mstp.c:420

ra8_mstp_init
ra8_err_t ra8_mstp_init(void)
Re-establish the ra8_mstp ref-count table from current hardware state.
Definition ra8_mstp.c:291

ra8_mstp_disable
ra8_err_t ra8_mstp_disable(ra8_mstp_t id)
Reference-counted "gate this peripheral" request.
Definition ra8_mstp.c:382

ra8_mstp_regs.h
Module Stop Control (MSTP) register layout for the Renesas RA8D2.

ra8_mstp_t
ra8_mstp_t
Packed (reg << 8) | bit module-stop identifier.
Definition ra8_mstp_regs.h:140