hal_clk.h

Go to the documentation of this file.

#ifndef HAL_CLK_H
#define HAL_CLK_H

#include <stdint.h>
#include "hal_config.h"
#include "hal_defs.h"


// -----------------------------------------------------------------------------
//  PUBLIC TYPEDEFS
// -----------------------------------------------------------------------------

typedef struct ClockControllerDesc* ClockController;

struct ClockControllerDesc {
    HALRESULT (*Init)(ClockController cc);
    HALRESULT (*Deinit)(ClockController cc);
    HALRESULT (*SetClockSource)(ClockController cc, int clk, int clk_src, uint32_t freq);
    int (*GetClockSource)(ClockController cc, int clk);
    uint32_t (*GetClockSourceFreq)(ClockController cc, int clk_src);
    uint32_t (*SetClockFrequency)(ClockController cc, int clk, uint32_t freq);
    uint32_t (*GetClockFrequency)(ClockController cc, int clk);
};


// -----------------------------------------------------------------------------
//  PUBLIC API
// -----------------------------------------------------------------------------

#define CC_DEFAULT_CLOCK                0

#define CC_Init(cc)                     (cc)->Init(cc)

#define CC_Deinit(cc)                   (cc)->Deinit(cc)

#define CC_SetClockSource(cc, clk, clk_src, freq)   (cc)->SetClockSource((cc), (clk), (clk_src), (freq))

#define CC_GetClockSource(cc, clk)              (cc)->GetClockSource((cc), (clk))

#define CC_GetClockSourceFreq(cc, clk)          (cc)->GetClockSourceFreq((cc), (clk))

#define CC_SetClockFreq(cc, clk, freq)          (cc)->SetClockFreq((cc), (clk), (freq))

#define CC_GetClockFreq(cc, clk)                    (cc)->GetClockFrequency((cc), (clk))

#endif /* HAL_CLK_H */