clocks.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _HARDWARE_CLOCKS_H
#define _HARDWARE_CLOCKS_H
 
#include "pico.h"
#include "hardware/structs/clocks.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define KHZ 1000
#define MHZ 1000000
 
// PICO_CONFIG: PARAM_ASSERTIONS_ENABLED_CLOCKS, Enable/disable assertions in the clocks module, type=bool, default=0, group=hardware_clocks
#ifndef PARAM_ASSERTIONS_ENABLED_CLOCKS
#define PARAM_ASSERTIONS_ENABLED_CLOCKS 0
#endif
 
void clocks_init(void);
 
bool clock_configure(enum clock_index clk_index, uint32_t src, uint32_t auxsrc, uint32_t src_freq, uint32_t freq);
 
void clock_stop(enum clock_index clk_index);
 
uint32_t clock_get_hz(enum clock_index clk_index);
 
uint32_t frequency_count_khz(uint src);
 
void clock_set_reported_hz(enum clock_index clk_index, uint hz);
 
static inline float frequency_count_mhz(uint src) {
    return ((float) (frequency_count_khz(src))) / KHZ;
}
 
typedef void (*resus_callback_t)(void);
 
void clocks_enable_resus(resus_callback_t resus_callback);
 
void clock_gpio_init_int_frac(uint gpio, uint src, uint32_t div_int, uint8_t div_frac);
 
static inline void clock_gpio_init(uint gpio, uint src, float div)
{
    uint div_int = (uint)div;
    uint8_t frac = (uint8_t)((div - (float)div_int) * (1u << CLOCKS_CLK_GPOUT0_DIV_INT_LSB));
    clock_gpio_init_int_frac(gpio, src, div_int, frac);
}
 
bool clock_configure_gpin(enum clock_index clk_index, uint gpio, uint32_t src_freq, uint32_t freq);
 
 
#ifdef __cplusplus
}
#endif
 
#endif