ata663211 2.0.0.0
Public function

Functions

void ata663211_cfg_setup (ata663211_cfg_t *cfg)
 Config Object Initialization function.
 
err_t ata663211_init (ata663211_t *ctx, ata663211_cfg_t *cfg)
 Initialization function.
 
err_t ata663211_generic_write (ata663211_t *ctx, uint8_t *data_buf, uint16_t len)
 Generic write function.
 
err_t ata663211_generic_read (ata663211_t *ctx, uint8_t *data_buf, uint16_t len)
 Generic read function.
 
void ata663211_wake_up_device (ata663211_t *ctx)
 Wake-up device function.
 
void ata663211_sleep_mode (ata663211_t *ctx)
 Sleep mode function.
 
uint8_t ata663211_check_inh (ata663211_t *ctx)
 Check inhibit pin state function.
 

Detailed Description

Function Documentation

◆ ata663211_cfg_setup()

void ata663211_cfg_setup ( ata663211_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

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

Note
All used pins will be set to unconnected state.

◆ ata663211_check_inh()

uint8_t ata663211_check_inh ( ata663211_t * ctx)

Check inhibit pin state function.

Parameters
ctxClick object.
Returns
Result State of the inhibit pin

@description This function is used to check the state of inhibit pin.

◆ ata663211_generic_read()

err_t ata663211_generic_read ( ata663211_t * ctx,
uint8_t * data_buf,
uint16_t len )

Generic read function.

Parameters
ctxClick object.
data_bufOutput data buffer.
lenNumber of the bytes in data buffer.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation. @description This function reads data.

◆ ata663211_generic_write()

err_t ata663211_generic_write ( ata663211_t * ctx,
uint8_t * data_buf,
uint16_t len )

Generic write function.

Parameters
ctxClick object.
data_bufInput data buffer
lenNumber of the bytes in the data buffer
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation. @description This function writes data.

◆ ata663211_init()

err_t ata663211_init ( ata663211_t * ctx,
ata663211_cfg_t * cfg )

Initialization function.

Parameters
ata663211Click object.
cfgClick configuration structure.

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

◆ ata663211_sleep_mode()

void ata663211_sleep_mode ( ata663211_t * ctx)

Sleep mode function.

Parameters
ctxClick object.

@description This function engages the sleep mode.

◆ ata663211_wake_up_device()

void ata663211_wake_up_device ( ata663211_t * ctx)

Wake-up device function.

Parameters
ctxClick object.

@description This function engages the normal mode.