ata6501 2.2.0
Loading...
Searching...
No Matches
ATA6501 Click Driver

API for configuring and manipulating ATA6501 Click driver. More...

Topics

 ATA6501 Device Settings
 Settings for registers of ATA6501 Click driver.
 ATA6501 MikroBUS Map
 MikroBUS pin mapping of ATA6501 Click driver.

Functions

void ata6501_cfg_setup (ata6501_cfg_t *cfg)
 ATA6501 configuration object setup function.
err_t ata6501_init (ata6501_t *ctx, ata6501_cfg_t *cfg)
 ATA6501 initialization function.
err_t ata6501_generic_write (ata6501_t *ctx, uint8_t *data_in, uint16_t len)
 ATA6501 data writing function.
err_t ata6501_generic_read (ata6501_t *ctx, uint8_t *data_out, uint16_t len)
 ATA6501 data reading function.
void ata6501_set_en_pin (ata6501_t *ctx, uint8_t state)
 ATA6501 set EN pin function.

Detailed Description

API for configuring and manipulating ATA6501 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ ata6501_cfg_setup()

void ata6501_cfg_setup ( ata6501_cfg_t * cfg)

ATA6501 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See ata6501_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ ata6501_generic_read()

err_t ata6501_generic_read ( ata6501_t * ctx,
uint8_t * data_out,
uint16_t len )

ATA6501 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ata6501_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ ata6501_generic_write()

err_t ata6501_generic_write ( ata6501_t * ctx,
uint8_t * data_in,
uint16_t len )

ATA6501 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See ata6501_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ata6501_init()

err_t ata6501_init ( ata6501_t * ctx,
ata6501_cfg_t * cfg )

ATA6501 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See ata6501_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See ata6501_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ ata6501_set_en_pin()

void ata6501_set_en_pin ( ata6501_t * ctx,
uint8_t state )

ATA6501 set EN pin function.

This function sets the EN pin logic state.

Parameters
[in]ctx: Click context object. See ata6501_t object definition for detailed explanation.
[in]state: Pin logic state.
Returns
None.
Note
None.