LibDriver EM4095
Loading...
Searching...
No Matches
em4095 basic driver function
em4095 driver function

em4095 basic driver modules More...

Collaboration diagram for em4095 basic driver function:

Data Structures

struct  em4095_time_s
 em4095 time structure definition More...
struct  em4095_decode_s
 em4095 decode structure definition More...
struct  em4095_handle_s
 em4095 handle structure definition More...
struct  em4095_info_s
 em4095 information structure definition More...

Macros

#define EM4095_MAX_LENGTH   384
 em4095 max length definition

Typedefs

typedef struct em4095_time_s em4095_time_t
 em4095 time structure definition
typedef struct em4095_decode_s em4095_decode_t
 em4095 decode structure definition
typedef struct em4095_handle_s em4095_handle_t
 em4095 handle structure definition
typedef struct em4095_info_s em4095_info_t
 em4095 information structure definition

Enumerations

enum  em4095_mode_t { EM4095_MODE_IDLE = 0x00 , EM4095_MODE_READ = 0x01 , EM4095_MODE_WRITE = 0x02 }
 em4095 mode enumeration definition More...

Functions

uint8_t em4095_info (em4095_info_t *info)
 get chip's information
uint8_t em4095_irq_handler (em4095_handle_t *handle)
 irq handler
uint8_t em4095_init (em4095_handle_t *handle)
 initialize the chip
uint8_t em4095_deinit (em4095_handle_t *handle)
 close the chip
uint8_t em4095_read (em4095_handle_t *handle, uint16_t len)
 read data
uint8_t em4095_write (em4095_handle_t *handle, uint8_t *buf, uint16_t len)
 write data
uint8_t em4095_copy_decode_buffer (em4095_handle_t *handle, uint8_t *buf, uint16_t *len)
 copy decode buffer
uint8_t em4095_power_on (em4095_handle_t *handle)
 power on
uint8_t em4095_power_down (em4095_handle_t *handle)
 power down
uint8_t em4095_set_div (em4095_handle_t *handle, uint32_t clock_div)
 set irq div
uint8_t em4095_get_div (em4095_handle_t *handle, uint32_t *clock_div)
 get irq div

Detailed Description

em4095 basic driver modules

Macro Definition Documentation

◆ EM4095_MAX_LENGTH

#define EM4095_MAX_LENGTH   384

em4095 max length definition

384

Definition at line 63 of file driver_em4095.h.

Typedef Documentation

◆ em4095_decode_t

typedef struct em4095_decode_s em4095_decode_t

em4095 decode structure definition

◆ em4095_handle_t

typedef struct em4095_handle_s em4095_handle_t

em4095 handle structure definition

◆ em4095_info_t

typedef struct em4095_info_s em4095_info_t

em4095 information structure definition

◆ em4095_time_t

typedef struct em4095_time_s em4095_time_t

em4095 time structure definition

Enumeration Type Documentation

◆ em4095_mode_t

enum em4095_mode_t

em4095 mode enumeration definition

Enumerator
EM4095_MODE_IDLE 

idle

EM4095_MODE_READ 

read

EM4095_MODE_WRITE 

write

Definition at line 69 of file driver_em4095.h.

Function Documentation

◆ em4095_copy_decode_buffer()

uint8_t em4095_copy_decode_buffer ( em4095_handle_t * handle,
uint8_t * buf,
uint16_t * len )

copy decode buffer

Parameters
[in]*handlepointer to an em4095 handle structure
[out]*bufpointer to a data buffer
[in]lenread length
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 767 of file driver_em4095.c.

◆ em4095_deinit()

uint8_t em4095_deinit ( em4095_handle_t * handle)

close the chip

Parameters
[in]*handlepointer to an em4095 handle structure
Returns
status code
  • 0 success
  • 1 deinit failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 451 of file driver_em4095.c.

◆ em4095_get_div()

uint8_t em4095_get_div ( em4095_handle_t * handle,
uint32_t * clock_div )

get irq div

Parameters
[in]*handlepointer to an em4095 handle structure
[out]*clock_divpointer to a div buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 608 of file driver_em4095.c.

◆ em4095_info()

uint8_t em4095_info ( em4095_info_t * info)

get chip's information

Parameters
[out]*infopointer to an em4095 info structure
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 797 of file driver_em4095.c.

◆ em4095_init()

uint8_t em4095_init ( em4095_handle_t * handle)

initialize the chip

Parameters
[in]*handlepointer to an em4095 handle structure
Returns
status code
  • 0 success
  • 1 gpio initialization failed
  • 2 handle is NULL
  • 3 linked functions is NULL
Note
none

Definition at line 297 of file driver_em4095.c.

◆ em4095_irq_handler()

uint8_t em4095_irq_handler ( em4095_handle_t * handle)

irq handler

Parameters
[in]*handlepointer to an em4095 handle structure
Returns
status code
  • 0 success
  • 1 run failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 163 of file driver_em4095.c.

◆ em4095_power_down()

uint8_t em4095_power_down ( em4095_handle_t * handle)

power down

Parameters
[in]*handlepointer to an em4095 handle structure
Returns
status code
  • 0 success
  • 1 power down failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 507 of file driver_em4095.c.

◆ em4095_power_on()

uint8_t em4095_power_on ( em4095_handle_t * handle)

power on

Parameters
[in]*handlepointer to an em4095 handle structure
Returns
status code
  • 0 success
  • 1 power on failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 541 of file driver_em4095.c.

◆ em4095_read()

uint8_t em4095_read ( em4095_handle_t * handle,
uint16_t len )

read data

Parameters
[in]*handlepointer to an em4095 handle structure
[in]lenread length
Returns
status code
  • 0 success
  • 1 read failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 len is too long
Note
none

Definition at line 636 of file driver_em4095.c.

◆ em4095_set_div()

uint8_t em4095_set_div ( em4095_handle_t * handle,
uint32_t clock_div )

set irq div

Parameters
[in]*handlepointer to an em4095 handle structure
[in]clock_divclock div
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 div can't be 0
Note
none

Definition at line 576 of file driver_em4095.c.

◆ em4095_write()

uint8_t em4095_write ( em4095_handle_t * handle,
uint8_t * buf,
uint16_t len )

write data

Parameters
[in]*handlepointer to an em4095 handle structure
[in]*bufpointer to a data buffer
[in]lenwritten length
Returns
status code
  • 0 success
  • 1 write failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 len is too long
Note
none

Definition at line 703 of file driver_em4095.c.