rtos_clock_control.h

// Copyright 2022 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.
 
#ifndef RTOS_CLOCK_CONTROL_H_
#define RTOS_CLOCK_CONTROL_H_
 
#include "xcore_clock_control.h"
 
#include "rtos_osal.h"
#include "rtos_driver_rpc.h"
#include "mrsw_lock.h"
 
typedef struct rtos_clock_control_struct rtos_clock_control_t;
 
struct rtos_clock_control_struct {
    rtos_driver_rpc_t *rpc_config;
 
    __attribute__((fptrgroup("rtos_clock_control_set_ref_clk_div_fptr_grp")))
    void (*set_ref_clk_div)(rtos_clock_control_t *, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_set_processor_clk_div_fptr_grp")))
    void (*set_processor_clk_div)(rtos_clock_control_t *, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_set_switch_clk_div_fptr_grp")))
    void (*set_switch_clk_div)(rtos_clock_control_t *, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_get_ref_clk_div_fptr_grp")))
    unsigned (*get_ref_clk_div)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_get_processor_clk_div_fptr_grp")))
    unsigned (*get_processor_clk_div)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_get_switch_clk_div_fptr_grp")))
    unsigned (*get_switch_clk_div)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_get_processor_clock_fptr_grp")))
    unsigned (*get_processor_clock)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_get_ref_clock_fptr_grp")))
    unsigned (*get_ref_clock)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_get_switch_clock_fptr_grp")))
    unsigned (*get_switch_clock)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_set_node_pll_ratio_fptr_grp")))
    void (*set_node_pll_ratio)(rtos_clock_control_t *, unsigned, unsigned, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_get_node_pll_ratio_fptr_grp")))
    void (*get_node_pll_ratio)(rtos_clock_control_t *, unsigned *, unsigned *, unsigned *);
 
    __attribute__((fptrgroup("rtos_clock_control_scale_links_fptr_grp")))
    void (*scale_links)(rtos_clock_control_t *, unsigned, unsigned, unsigned, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_reset_links_fptr_grp")))
    void (*reset_links)(rtos_clock_control_t *, unsigned, unsigned);
 
    __attribute__((fptrgroup("rtos_clock_control_get_local_lock_fptr_grp")))
    void (*get_local_lock)(rtos_clock_control_t *);
 
    __attribute__((fptrgroup("rtos_clock_control_release_local_lock_fptr_grp")))
    void (*release_local_lock)(rtos_clock_control_t *);
 
    mrsw_lock_t local_lock;
    rtos_osal_mutex_t lock; /* Only used by RPC client */
};
 
#include "rtos_clock_control_rpc.h"
 
inline void rtos_clock_control_set_ref_clk_div(
        rtos_clock_control_t *ctx,
        unsigned divider)
{
    ctx->set_ref_clk_div(ctx, divider);
}
 
inline unsigned rtos_clock_control_get_ref_clk_div(
        rtos_clock_control_t *ctx)
{
    return ctx->get_ref_clk_div(ctx);
}
 
inline void rtos_clock_control_set_processor_clk_div(
        rtos_clock_control_t *ctx,
        unsigned divider)
{
    ctx->set_processor_clk_div(ctx, divider);
}
 
inline unsigned rtos_clock_control_get_processor_clk_div(
        rtos_clock_control_t *ctx)
{
    return ctx->get_processor_clk_div(ctx);
}
 
inline void rtos_clock_control_set_switch_clk_div(
        rtos_clock_control_t *ctx,
        unsigned divider)
{
    ctx->set_switch_clk_div(ctx, divider);
}
 
inline unsigned rtos_clock_control_get_switch_clk_div(
        rtos_clock_control_t *ctx)
{
    return ctx->get_switch_clk_div(ctx);
}
 
inline unsigned rtos_clock_control_get_ref_clock(
        rtos_clock_control_t *ctx)
{
    return ctx->get_ref_clock(ctx);
}
 
inline unsigned rtos_clock_control_get_processor_clock(
        rtos_clock_control_t *ctx)
{
    return ctx->get_processor_clock(ctx);
}
 
inline unsigned rtos_clock_control_get_switch_clock(
        rtos_clock_control_t *ctx)
{
    return ctx->get_switch_clock(ctx);
}
 
inline void rtos_clock_control_scale_links(
        rtos_clock_control_t *ctx,
        unsigned start_addr,
        unsigned end_addr,
        unsigned delay_intra,
        unsigned delay_inter)
{
    ctx->scale_links(ctx, start_addr, end_addr, delay_intra, delay_inter);
}
 
inline void rtos_clock_control_reset_links(
        rtos_clock_control_t *ctx,
        unsigned start_addr,
        unsigned end_addr)
{
    ctx->reset_links(ctx, start_addr, end_addr);
}
 
inline void rtos_clock_control_set_node_pll_ratio(
        rtos_clock_control_t *ctx,
        unsigned pre_div,
        unsigned mul,
        unsigned post_div)
{
    ctx->set_node_pll_ratio(ctx, pre_div, mul, post_div);
}
 
inline void rtos_clock_control_get_node_pll_ratio(
        rtos_clock_control_t *ctx,
        unsigned *pre_div,
        unsigned *mul,
        unsigned *post_div)
{
    ctx->get_node_pll_ratio(ctx, pre_div, mul, post_div);
}
 
inline void rtos_clock_control_get_local_lock(
        rtos_clock_control_t *ctx)
{
    ctx->get_local_lock(ctx);
}
 
inline void rtos_clock_control_release_local_lock(
        rtos_clock_control_t *ctx)
{
    ctx->release_local_lock(ctx);
}
 
void rtos_clock_control_start(
        rtos_clock_control_t *ctx);
 
void rtos_clock_control_init(
        rtos_clock_control_t *ctx);
 
#endif /* RTOS_CLOCK_CONTROL_H_ */