This file contains API for Clock Gen 5 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Data Structures
struct	clockgen5_t
	Clock Gen 5 Click context object. More...

struct	clockgen5_cfg_t
	Clock Gen 5 Click configuration object. More...

Macros
#define	CLOCKGEN5_OCT_0 0
	Clock Gen 5 description setting.

#define	CLOCKGEN5_OCT_1 1

#define	CLOCKGEN5_OCT_2 2

#define	CLOCKGEN5_OCT_3 3

#define	CLOCKGEN5_OCT_4 4

#define	CLOCKGEN5_OCT_5 5

#define	CLOCKGEN5_OCT_6 6

#define	CLOCKGEN5_OCT_7 7

#define	CLOCKGEN5_OCT_8 8

#define	CLOCKGEN5_OCT_9 9

#define	CLOCKGEN5_OCT_10 10

#define	CLOCKGEN5_OCT_11 11

#define	CLOCKGEN5_OCT_12 12

#define	CLOCKGEN5_OCT_13 13

#define	CLOCKGEN5_OCT_14 14

#define	CLOCKGEN5_OCT_15 15

#define	CLOCKGEN5_OUTPUT_DISABLE 0x00
	Clock Gen 5 output enable or fisable.

#define	CLOCKGEN5_OUTPUT_ENABLE 0x01

#define	CLOCKGEN5_CFG_ON_CLK_180 0x00
	Clock Gen 5 config settings.

#define	CLOCKGEN5_CFG_OFF_ON 0x01

#define	CLOCKGEN5_CFG_ON_OFF 0x02

#define	CLOCKGEN5_CFG_POWER_DOWN 0x03

#define	CLOCKGEN5_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.

#define	CLOCKGEN5_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE

#define	CLOCKGEN5_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	clockgen5_return_value_t { CLOCKGEN5_OK = 0 , CLOCKGEN5_ERROR = -1 }
	Clock Gen 5 Click return value data. More...

Functions
void	clockgen5_cfg_setup (clockgen5_cfg_t *cfg)
	Clock Gen 5 configuration object setup function.

err_t	clockgen5_init (clockgen5_t ctx, clockgen5_cfg_t cfg)
	Clock Gen 5 initialization function.

void	clockgen5_out_enable (clockgen5_t *ctx, uint8_t en_out)
	Enable output function.

void	clockgen5_set_config (clockgen5_t *ctx, uint8_t cfg)
	Set configuration function.

void	clockgen5_set_freq (clockgen5_t *ctx, float freq)
	Set frequency function.

Detailed Description

This file contains API for Clock Gen 5 Click Driver.

Enumeration Type Documentation

Clock Gen 5 Click return value data.

Predefined enum values for driver return values.

Enumerator
CLOCKGEN5_OK
CLOCKGEN5_ERROR