Public function

Functions
void	clockgen2_cfg_setup (clockgen2_cfg_t *cfg)
	Config Object Initialization function.
CLOCKGEN2_RETVAL	clockgen2_init (clockgen2_t *ctx, clockgen2_cfg_t *cfg)
	Initialization function.
void	clockgen2_generic_write (clockgen2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic write function.
void	clockgen2_generic_read (clockgen2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
	Generic read function.
void	clockgen2_set_dtr_pin (clockgen2_t *ctx, uint8_t state)
	Set dtr pin function.
void	clockgen2_set_pdn_pin (clockgen2_t *ctx, uint8_t state)
	Set pdn pin function.
void	clockgen2_set_oe_pin (clockgen2_t *ctx, uint8_t state)
	Set oe pin function.
void	clockgen2_write (clockgen2_t *ctx, uint8_t w_reg, uint8_t w_data)
	Writing 1B function.
void	clockgen2_set_prescaler (clockgen2_t *ctx, uint8_t val)
	Prescaler set function.
void	clockgen2_change_address (clockgen2_t *ctx, uint8_t new_addr)
	Prescaler set function.
void	clockgen2_store_config (clockgen2_t *ctx)
	Settings save function.
void	clockgen2_auto_setting_preserve (clockgen2_t *ctx, uint8_t state)
	Auto setting preservation function.
void	clockgen2_output_enable (clockgen2_t *ctx, uint8_t state)
	Settings save function.

Detailed Description

Function Documentation

clockgen2_auto_setting_preserve()

void clockgen2_auto_setting_preserve	(	clockgen2_t *	ctx,
		uint8_t	state )

Auto setting preservation function.

Parameters

ctx	Click object.
state	Value to comapre with Enable/Disable registers.

@description Function used for enabling/disabling auto settings preservation.

Note

This option needs to be disabled if the eeprom settings are changed very often to minimize the wear of the eeprom memory.

clockgen2_cfg_setup()

void clockgen2_cfg_setup

(

clockgen2_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

clockgen2_change_address()

void clockgen2_change_address	(	clockgen2_t *	ctx,
		uint8_t	new_addr )

Prescaler set function.

Parameters

ctx	Click object.
new_addr	New slave address.

@description Function configures the clockgen2 slave address at runtime.

Note

User can chose between 7 differnet addresses. The default unshifted 7bit address is 0x58.

clockgen2_generic_read()

void clockgen2_generic_read	(	clockgen2_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic read function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number of the bytes to be read

@description This function reads data from the desired register.

clockgen2_generic_write()

void clockgen2_generic_write	(	clockgen2_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_buf,
		uint8_t	len )

Generic write function.

Parameters

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description This function writes data to the desired register.

clockgen2_init()

CLOCKGEN2_RETVAL clockgen2_init	(	clockgen2_t *	ctx,
		clockgen2_cfg_t *	cfg )

Initialization function.

Parameters

clockgen2	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

clockgen2_output_enable()

void clockgen2_output_enable	(	clockgen2_t *	ctx,
		uint8_t	state )

Settings save function.

Parameters

ctx	Click object.
state	Pin value.

@description Function for enabling/disabling of the clock output.

clockgen2_set_dtr_pin()

void clockgen2_set_dtr_pin	(	clockgen2_t *	ctx,
		uint8_t	state )

Set dtr pin function.

Parameters

ctx	Click object.
state	Pin state value.

@description Set the state of the DTR pin.

clockgen2_set_oe_pin()

void clockgen2_set_oe_pin	(	clockgen2_t *	ctx,
		uint8_t	state )

Set oe pin function.

Parameters

ctx	Click object.
state	Pin state value.

@description Set the state of the OE pin.

clockgen2_set_pdn_pin()

void clockgen2_set_pdn_pin	(	clockgen2_t *	ctx,
		uint8_t	state )

Set pdn pin function.

Parameters

ctx	Click object.
state	Pin state value.

@description Set the state of the PDN pin.

clockgen2_set_prescaler()

void clockgen2_set_prescaler	(	clockgen2_t *	ctx,
		uint8_t	val )

Prescaler set function.

Parameters

ctx	Click object.
val	Write address.

@description Function for setting the main clock prescaler.

Note

Prescaler range is from 0 - 8.

clockgen2_store_config()

void clockgen2_store_config

(

clockgen2_t *

ctx

)

Settings save function.

Parameters

ctx	Click object.

@description Function used for saving the settings to the eeprom if the the auto preserve settings is disabled.

clockgen2_write()

void clockgen2_write	(	clockgen2_t *	ctx,
		uint8_t	w_reg,
		uint8_t	w_data )

Writing 1B function.

Parameters

ctx	Click object.
w_reg	Write address.
w_data	Data to be written.

@description Function for writing data to a specified register.