freqm_8h_source.html

/*

 * Copyright (C) 2023 ML!PA Consulting GmbH

 *

 * This file is subject to the terms and conditions of the GNU Lesser

 * General Public License v2.1. See the file LICENSE in the top level

 * directory for more details.

 */


#ifndef PERIPH_FREQM_H

#define PERIPH_FREQM_H


#include <errno.h>

#include <mutex.h>


#include "periph_cpu.h"

#include "periph/gpio.h"

#include "time_units.h"


#ifdef __cplusplus

extern "C" {

#endif


typedef void (*freqm_cb_t)(uint32_t result, bool overflow, void *context);


#ifndef HAVE_FREQM_T

typedef uint_fast8_t freqm_t;

#endif


void freqm_init(freqm_t idx);


void freqm_frequency_get_async(freqm_t idx, freqm_cb_t freqm_cb, void *context,

                               uint32_t period_us);


int freqm_frequency_get(freqm_t idx, uint32_t *result, uint32_t period_us);


#ifdef __cplusplus

}

#endif


#endif /* PERIPH_FREQM_H */

gpio.h
Low-level GPIO peripheral driver interface definitions.

errno.h

freqm_frequency_get_async
void freqm_frequency_get_async(freqm_t idx, freqm_cb_t freqm_cb, void *context, uint32_t period_us)
Read number of periods of measured clock and calculate its frequency.

freqm_frequency_get
int freqm_frequency_get(freqm_t idx, uint32_t *result, uint32_t period_us)
Read number of periods of measured clock and calculate its frequency.

freqm_init
void freqm_init(freqm_t idx)
Initialize the frequency meter.

freqm_t
uint_fast8_t freqm_t
Define default Frequency meter type identifier.
Definition freqm.h:56

freqm_cb_t
void(* freqm_cb_t)(uint32_t result, bool overflow, void *context)
Frequency meter callback function.
Definition freqm.h:50

mutex.h
Mutex for thread synchronization.

time_units.h
Utility header providing time unit defines.