ra8_pdg.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_pdg_regs.h"

typedef enum : uint8_t {
  k_ra8_pdg_edge_rising  = 0U, 
  k_ra8_pdg_edge_falling = 1U, 
} ra8_pdg_edge_t;

typedef enum : uint8_t {
  k_ra8_pdg_pin_a = 0U, 
  k_ra8_pdg_pin_b = 1U, 
} ra8_pdg_pin_t;

typedef enum : uint16_t {
  k_ra8_pdg_status_dll_locked = 0x0001U, 
  k_ra8_pdg_status_in_reset   = 0x0002U, 
  k_ra8_pdg_status_frange_msk = 0x0300U, 
} ra8_pdg_status_t;

typedef enum : uint8_t {
  k_ra8_pdg_dir_up   = 0U, 
  k_ra8_pdg_dir_down = 1U, 
} ra8_pdg_count_dir_t;

typedef enum : uint8_t {
  k_ra8_pdg_wave_saw      = 0U, 
  k_ra8_pdg_wave_triangle = 1U, 
} ra8_pdg_wave_mode_t;

typedef struct {
  ra8_pdg_frange_t frange;       
  uint8_t          channel_mask; 
  uint8_t          auto_tune;    
  uint32_t         gptclk_hz;    
} ra8_pdg_config_t;

typedef struct {
  uint8_t          dll_enabled;                                     
  uint8_t          in_reset;                                        
  ra8_pdg_frange_t frange;                                          
  uint8_t          per_channel_bypass_off[k_ra8_pdg_channel_count]; 
  uint8_t          per_channel_powered[k_ra8_pdg_channel_count];    
  uint16_t         raw_gtdlycr;                                     
  uint16_t         raw_gtdlycr2;                                    
} ra8_pdg_status_full_t;

typedef struct {
  uint8_t        channel; 
  ra8_pdg_pin_t  pin;     
  ra8_pdg_edge_t edge;    
  uint8_t        code;    
} ra8_pdg_delay_entry_t;

typedef void (*ra8_pdg_event_fn_t)(void* ctx);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_init(const ra8_pdg_config_t* cfg);

[[nodiscard]] ra8_err_t ra8_pdg_deinit(void);
 
/* =============================================================================
 * Per-edge delay programming
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_pdg_set_delay(uint8_t channel, ra8_pdg_pin_t pin, ra8_pdg_edge_t edge, uint8_t code);

[[nodiscard]] ra8_err_t
ra8_pdg_get_delay(uint8_t channel, ra8_pdg_pin_t pin, ra8_pdg_edge_t edge, uint8_t* out_code);

[[nodiscard]] ra8_err_t ra8_pdg_set_delay_batch(const ra8_pdg_delay_entry_t* entries,
                                                uint8_t                      count);

[[nodiscard]] ra8_err_t ra8_pdg_delay_ns_to_code(uint32_t         delay_ns,
                                                 uint32_t         gptclk_hz,
                                                 ra8_pdg_frange_t frange,
                                                 uint8_t*         out_code);
 
/* =============================================================================
 * Per-channel and per-pin power transition
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_exit_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_pdg_enter_stop(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_pdg_channel_bypass_set(uint8_t channel, uint8_t bypass);

[[nodiscard]] ra8_err_t ra8_pdg_pin_disable(uint8_t channel, ra8_pdg_pin_t pin);
 
/* =============================================================================
 * Status / IRQ
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_get_status(uint16_t* out);

[[nodiscard]] ra8_err_t ra8_pdg_get_status_full(ra8_pdg_status_full_t* out);

[[nodiscard]] ra8_err_t ra8_pdg_clear_status(uint16_t mask);

[[nodiscard]] ra8_err_t ra8_pdg_attach_handler(ra8_pdg_event_fn_t fn, void* ctx);

void ra8_pdg_dispatch(void);
 
/* =============================================================================
 * Runtime FRANGE switch + auto-tune calibration
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_pick_frange(uint32_t gptclk_hz, ra8_pdg_frange_t* out);

[[nodiscard]] ra8_err_t ra8_pdg_set_frange(ra8_pdg_frange_t new_frange);
 
/* =============================================================================
 * GPT0/1/2/3 binding helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_bind_gpt_channel(uint8_t channel);

[[nodiscard]] ra8_err_t ra8_pdg_unbind_gpt_channel(uint8_t channel);
 
/* =============================================================================
 * Constraint validation (HUM Ch 23.4.2 / 23.4.3)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_check_constraints(ra8_pdg_wave_mode_t mode,
                                                  ra8_pdg_count_dir_t dir,
                                                  uint32_t            compare_match,
                                                  uint32_t            gtpr);

[[nodiscard]] ra8_err_t
ra8_pdg_required_write_ns(uint32_t pclka_hz, uint32_t gptclk_hz, uint32_t* out_ns);
 
/* =============================================================================
 * Sweep 17: capture-style buffered delay-code apply + completion callback
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_pdg_capture_start(const ra8_pdg_delay_entry_t* buf, uint8_t len);

[[nodiscard]] ra8_err_t ra8_pdg_capture_stop(void);
 
#ifdef __cplusplus
}
#endif