LibDriver MFRC522  1.0.0
MFRC522 full-featured driver
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
mfrc522 interface driver function
mfrc522 driver function

mfrc522 interface driver modules More...

Functions

uint8_t mfrc522_interface_reset_gpio_init (void)
 interface reset gpio init More...
 
uint8_t mfrc522_interface_reset_gpio_deinit (void)
 interface reset gpio deinit More...
 
uint8_t mfrc522_interface_reset_gpio_write (uint8_t value)
 interface reset gpio write More...
 
uint8_t mfrc522_interface_iic_init (void)
 interface iic bus init More...
 
uint8_t mfrc522_interface_iic_deinit (void)
 interface iic bus deinit More...
 
uint8_t mfrc522_interface_iic_read (uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 interface iic bus read More...
 
uint8_t mfrc522_interface_iic_write (uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len)
 interface iic bus write More...
 
uint8_t mfrc522_interface_spi_init (void)
 interface spi bus init More...
 
uint8_t mfrc522_interface_spi_deinit (void)
 interface spi bus deinit More...
 
uint8_t mfrc522_interface_spi_read (uint8_t reg, uint8_t *buf, uint16_t len)
 interface spi bus read More...
 
uint8_t mfrc522_interface_spi_write (uint8_t reg, uint8_t *buf, uint16_t len)
 interface spi bus write More...
 
uint8_t mfrc522_interface_uart_init (void)
 interface uart init More...
 
uint8_t mfrc522_interface_uart_deinit (void)
 interface uart deinit More...
 
uint16_t mfrc522_interface_uart_read (uint8_t *buf, uint16_t len)
 interface uart read More...
 
uint8_t mfrc522_interface_uart_write (uint8_t *buf, uint16_t len)
 interface uart write More...
 
uint8_t mfrc522_interface_uart_flush (void)
 interface uart flush More...
 
void mfrc522_interface_delay_ms (uint32_t ms)
 interface delay ms More...
 
void mfrc522_interface_debug_print (const char *const fmt,...)
 interface print format data More...
 
void mfrc522_interface_receive_callback (uint16_t type)
 interface receive callback More...
 

Detailed Description

mfrc522 interface driver modules

Function Documentation

◆ mfrc522_interface_debug_print()

void mfrc522_interface_debug_print ( const char *const  fmt,
  ... 
)

interface print format data

Parameters
[in]fmtformat data
Note
none

Definition at line 265 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_delay_ms()

void mfrc522_interface_delay_ms ( uint32_t  ms)

interface delay ms

Parameters
[in]mstime
Note
none

Definition at line 255 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_iic_deinit()

uint8_t mfrc522_interface_iic_deinit ( void  )

interface iic bus deinit

Returns
status code
  • 0 success
  • 1 iic deinit failed
Note
none

Definition at line 95 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_iic_init()

uint8_t mfrc522_interface_iic_init ( void  )

interface iic bus init

Returns
status code
  • 0 success
  • 1 iic init failed
Note
none

Definition at line 83 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_iic_read()

uint8_t mfrc522_interface_iic_read ( uint8_t  addr,
uint8_t  reg,
uint8_t *  buf,
uint16_t  len 
)

interface iic bus read

Parameters
[in]addriic device write address
[in]regiic register address
[out]*bufpointer to a data buffer
[in]lenlength of the data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 111 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_iic_write()

uint8_t mfrc522_interface_iic_write ( uint8_t  addr,
uint8_t  reg,
uint8_t *  buf,
uint16_t  len 
)

interface iic bus write

Parameters
[in]addriic device write address
[in]regiic register address
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 127 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_receive_callback()

void mfrc522_interface_receive_callback ( uint16_t  type)

interface receive callback

Parameters
[in]typeirq type
Note
none

Definition at line 275 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_reset_gpio_deinit()

uint8_t mfrc522_interface_reset_gpio_deinit ( void  )

interface reset gpio deinit

Returns
status code
  • 0 success
  • 1 reset gpio deinit failed
Note
none

Definition at line 58 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_reset_gpio_init()

uint8_t mfrc522_interface_reset_gpio_init ( void  )

interface reset gpio init

Returns
status code
  • 0 success
  • 1 reset gpio init failed
Note
none

Definition at line 46 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_reset_gpio_write()

uint8_t mfrc522_interface_reset_gpio_write ( uint8_t  value)

interface reset gpio write

Parameters
[in]valuewritten value
Returns
status code
  • 0 success
  • 1 reset gpio write failed
Note
none

Definition at line 71 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_spi_deinit()

uint8_t mfrc522_interface_spi_deinit ( void  )

interface spi bus deinit

Returns
status code
  • 0 success
  • 1 spi deinit failed
Note
none

Definition at line 151 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_spi_init()

uint8_t mfrc522_interface_spi_init ( void  )

interface spi bus init

Returns
status code
  • 0 success
  • 1 spi init failed
Note
none

Definition at line 139 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_spi_read()

uint8_t mfrc522_interface_spi_read ( uint8_t  reg,
uint8_t *  buf,
uint16_t  len 
)

interface spi bus read

Parameters
[in]regregister address
[out]*bufpointer to a data buffer
[in]lenlength of data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 166 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_spi_write()

uint8_t mfrc522_interface_spi_write ( uint8_t  reg,
uint8_t *  buf,
uint16_t  len 
)

interface spi bus write

Parameters
[in]regregister address
[in]*bufpointer to a data buffer
[in]lenlength of data buffer
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 181 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_uart_deinit()

uint8_t mfrc522_interface_uart_deinit ( void  )

interface uart deinit

Returns
status code
  • 0 success
  • 1 uart deinit failed
Note
none

Definition at line 205 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_uart_flush()

uint8_t mfrc522_interface_uart_flush ( void  )

interface uart flush

Returns
status code
  • 0 success
  • 1 uart flush failed
Note
none

Definition at line 245 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_uart_init()

uint8_t mfrc522_interface_uart_init ( void  )

interface uart init

Returns
status code
  • 0 success
  • 1 uart init failed
Note
none

Definition at line 193 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_uart_read()

uint16_t mfrc522_interface_uart_read ( uint8_t *  buf,
uint16_t  len 
)

interface uart read

Parameters
[out]*bufpointer to a data buffer
[in]lenlength of the data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 219 of file driver_mfrc522_interface_template.c.

◆ mfrc522_interface_uart_write()

uint8_t mfrc522_interface_uart_write ( uint8_t *  buf,
uint16_t  len 
)

interface uart write

Parameters
[in]*bufpointer to a data buffer
[in]lenlength of the data buffer
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 233 of file driver_mfrc522_interface_template.c.