xosc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _HARDWARE_XOSC_H
#define _HARDWARE_XOSC_H
 
#include "pico.h"
#include "hardware/structs/xosc.h"
 
// For frequency related definitions etc
#include "hardware/clocks.h"
 
 
// Allow lengthening startup delay to accommodate slow-starting oscillators
 
// PICO_CONFIG: PICO_XOSC_STARTUP_DELAY_MULTIPLIER, Multiplier (from 1ms) for xosc startup delay to accommodate slow-starting oscillators, type=int, min=1, default=6, group=hardware_xosc
#ifndef PICO_XOSC_STARTUP_DELAY_MULTIPLIER
#define PICO_XOSC_STARTUP_DELAY_MULTIPLIER 6
#endif
 
// PICO_CONFIG: PICO_XOSC_FREQ_RANGE_MAX, The maximum frequency in MHz for the XOSC to support (not required when using CMOS clock input instead of XOSC) - defining this variable is not supported on RP2040 as it only has one range, type=int, min=1, max=100, default=XOSC_HZ/MHZ, group=hardware_xosc
#if PICO_RP2040
#define PICO_XOSC_FREQ_RANGE_MAX 15
#else
#ifndef PICO_XOSC_FREQ_RANGE_MAX
#define PICO_XOSC_FREQ_RANGE_MAX (XOSC_HZ / MHZ)
#endif
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif


void xosc_init(void);

void xosc_disable(void);

void xosc_dormant(void);
 
#ifdef __cplusplus
}
#endif
 
#endif