clockgen6 2.0.0.0
clockgen6.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  clockgen6_t
 Clock Gen 6 Click context object. More...
 
struct  clockgen6_cfg_t
 Clock Gen 6 Click configuration object. More...
 

Macros

#define CLOCKGEN6_DIGIPOT_POSITION_MAX   255
 Clock Gen 6 digipot settings.
 
#define CLOCKGEN6_DIGIPOT_POSITION_MIN   0
 
#define CLOCKGEN6_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define CLOCKGEN6_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
#define CLOCKGEN6_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  clockgen6_return_value_t { CLOCKGEN6_OK = 0 , CLOCKGEN6_ERROR = -1 }
 Clock Gen 6 Click return value data. More...
 

Functions

void clockgen6_cfg_setup (clockgen6_cfg_t *cfg)
 Clock Gen 6 configuration object setup function.
 
err_t clockgen6_init (clockgen6_t *ctx, clockgen6_cfg_t *cfg)
 Clock Gen 6 initialization function.
 
err_t clockgen6_default_cfg (clockgen6_t *ctx)
 Clock Gen 6 default configuration function.
 
err_t clockgen6_set_digipot (clockgen6_t *ctx, uint8_t position)
 Clock Gen 6 set digipot function.
 
void clockgen6_enable_output (clockgen6_t *ctx)
 Clock Gen 6 enable output function.
 
void clockgen6_disable_output (clockgen6_t *ctx)
 Clock Gen 6 disable output function.
 

Detailed Description

This file contains API for Clock Gen 6 Click Driver.

Enumeration Type Documentation

◆ clockgen6_return_value_t

Clock Gen 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
CLOCKGEN6_OK 
CLOCKGEN6_ERROR