driver_ch9120.h File Reference

driver ch9120 header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>

Include dependency graph for driver_ch9120.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ch9120_handle_s
	ch9120 handle structure definition More...
struct	ch9120_info_s
	ch9120 information structure definition More...

Macros
#define	CH9120_UART_PRE_DELAY   50
	ch9120 uart pre delay definition
#define	DRIVER_CH9120_LINK_INIT(HANDLE, STRUCTURE)
	initialize ch9120 structure
#define	DRIVER_CH9120_LINK_UART_INIT(HANDLE, FUC)
	link uart_init function
#define	DRIVER_CH9120_LINK_UART_DEINIT(HANDLE, FUC)
	link uart_deinit function
#define	DRIVER_CH9120_LINK_UART_READ(HANDLE, FUC)
	link uart_read function
#define	DRIVER_CH9120_LINK_UART_WRITE(HANDLE, FUC)
	link uart_write function
#define	DRIVER_CH9120_LINK_UART_FLUSH(HANDLE, FUC)
	link uart_flush function
#define	DRIVER_CH9120_LINK_RESET_GPIO_INIT(HANDLE, FUC)
	link reset_gpio_init function
#define	DRIVER_CH9120_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)
	link reset_gpio_deinit function
#define	DRIVER_CH9120_LINK_RESET_GPIO_WRITE(HANDLE, FUC)
	link reset_gpio_write function
#define	DRIVER_CH9120_LINK_CFG_GPIO_INIT(HANDLE, FUC)
	link cfg_gpio_init function
#define	DRIVER_CH9120_LINK_CFG_GPIO_DEINIT(HANDLE, FUC)
	link cfg_gpio_deinit function
#define	DRIVER_CH9120_LINK_CFG_GPIO_WRITE(HANDLE, FUC)
	link cfg_gpio_write function
#define	DRIVER_CH9120_LINK_DELAY_MS(HANDLE, FUC)
	link delay_ms function
#define	DRIVER_CH9120_LINK_DEBUG_PRINT(HANDLE, FUC)
	link debug_print function

Typedefs
typedef struct ch9120_handle_s	ch9120_handle_t
	ch9120 handle structure definition
typedef struct ch9120_info_s	ch9120_info_t
	ch9120 information structure definition

Enumerations
enum	ch9120_bool_t { CH9120_BOOL_FALSE = 0x00 , CH9120_BOOL_TRUE = 0x01 }
	ch9120 bool enumeration definition More...
enum	ch9120_status_t { CH9120_STATUS_DISCONNECT = 0x00 , CH9120_STATUS_CONNECT = 0x01 }
	ch9120 status enumeration definition More...
enum	ch9120_mode_t { CH9120_MODE_TCP_SERVER = 0x00 , CH9120_MODE_TCP_CLIENT = 0x01 , CH9120_MODE_UDP_SERVER = 0x02 , CH9120_MODE_UDP_CLIENT = 0x03 }
	ch9120 mode enumeration definition More...
enum	ch9120_parity_t {   CH9120_PARITY_EVEN = 0x00 , CH9120_PARITY_ODD = 0x01 , CH9120_PARITY_MARK = 0x02 , CH9120_PARITY_SPACE = 0x03 ,   CH9120_PARITY_NONE = 0x04 }
	ch9120 parity enumeration definition More...

Functions
uint8_t	ch9120_info (ch9120_info_t *info)
	get chip's information
uint8_t	ch9120_init (ch9120_handle_t *handle)
	initialize the chip
uint8_t	ch9120_deinit (ch9120_handle_t *handle)
	close the chip
uint8_t	ch9120_read (ch9120_handle_t *handle, uint8_t *buf, uint16_t *len)
	read data
uint8_t	ch9120_write (ch9120_handle_t *handle, uint8_t *buf, uint16_t len)
	write data
uint8_t	ch9120_get_version (ch9120_handle_t *handle, uint8_t *version)
	get version
uint8_t	ch9120_reset (ch9120_handle_t *handle)
	reset the chip
uint8_t	ch9120_get_status (ch9120_handle_t *handle, ch9120_status_t *status)
	get status
uint8_t	ch9120_save_to_eeprom (ch9120_handle_t *handle)
	save to eeprom
uint8_t	ch9120_config_and_reset (ch9120_handle_t *handle)
	config and reset the chip
uint8_t	ch9120_exit (ch9120_handle_t *handle)
	exit
uint8_t	ch9120_set_mode (ch9120_handle_t *handle, ch9120_mode_t mode)
	set mode
uint8_t	ch9120_get_mode (ch9120_handle_t *handle, ch9120_mode_t *mode)
	get mode
uint8_t	ch9120_set_ip (ch9120_handle_t *handle, uint8_t ip[4])
	set ip address
uint8_t	ch9120_get_ip (ch9120_handle_t *handle, uint8_t ip[4])
	get ip address
uint8_t	ch9120_set_subnet_mask (ch9120_handle_t *handle, uint8_t mask[4])
	set subnet mask
uint8_t	ch9120_get_subnet_mask (ch9120_handle_t *handle, uint8_t mask[4])
	get subnet mask
uint8_t	ch9120_set_gateway (ch9120_handle_t *handle, uint8_t ip[4])
	set gateway
uint8_t	ch9120_get_gateway (ch9120_handle_t *handle, uint8_t ip[4])
	get gateway
uint8_t	ch9120_set_source_port (ch9120_handle_t *handle, uint16_t num)
	set source port
uint8_t	ch9120_get_source_port (ch9120_handle_t *handle, uint16_t *num)
	get source port
uint8_t	ch9120_set_dest_ip (ch9120_handle_t *handle, uint8_t ip[4])
	set dest ip
uint8_t	ch9120_get_dest_ip (ch9120_handle_t *handle, uint8_t ip[4])
	get dest ip
uint8_t	ch9120_set_dest_port (ch9120_handle_t *handle, uint16_t num)
	set dest port
uint8_t	ch9120_get_dest_port (ch9120_handle_t *handle, uint16_t *num)
	get dest port
uint8_t	ch9120_set_uart_baud (ch9120_handle_t *handle, uint32_t baud)
	set uart baud
uint8_t	ch9120_get_uart_baud (ch9120_handle_t *handle, uint32_t *baud)
	get uart baud
uint8_t	ch9120_set_uart_config (ch9120_handle_t *handle, uint8_t data_bit, ch9120_parity_t parity, uint8_t stop_bit)
	set uart config
uint8_t	ch9120_get_uart_config (ch9120_handle_t *handle, uint8_t *data_bit, ch9120_parity_t *parity, uint8_t *stop_bit)
	get uart config
uint8_t	ch9120_set_uart_timeout (ch9120_handle_t *handle, uint8_t timeout)
	set uart timeout
uint8_t	ch9120_get_uart_timeout (ch9120_handle_t *handle, uint8_t *timeout)
	get uart timeout
uint8_t	ch9120_uart_timeout_convert_to_register (ch9120_handle_t *handle, uint16_t ms, uint8_t *reg)
	convert the uart timeout to the register raw data
uint8_t	ch9120_uart_timeout_convert_to_data (ch9120_handle_t *handle, uint8_t reg, uint16_t *ms)
	convert the register raw data to the offset
uint8_t	ch9120_set_source_port_random (ch9120_handle_t *handle, ch9120_bool_t enable)
	enable or disable random source port number
uint8_t	ch9120_set_uart_buffer_length (ch9120_handle_t *handle, uint32_t len)
	set uart buffer length
uint8_t	ch9120_get_uart_buffer_length (ch9120_handle_t *handle, uint32_t *len)
	get uart buffer length
uint8_t	ch9120_set_uart_flush (ch9120_handle_t *handle, ch9120_bool_t enable)
	enable or disable uart auto flush
uint8_t	ch9120_get_uart_flush (ch9120_handle_t *handle, ch9120_bool_t *enable)
	get uart auto flush status
uint8_t	ch9120_set_disconnect_with_no_rj45 (ch9120_handle_t *handle, ch9120_bool_t enable)
	enable or disable disconnect with no rj45
uint8_t	ch9120_get_disconnect_with_no_rj45 (ch9120_handle_t *handle, ch9120_bool_t *enable)
	get disconnect with no rj45 status
uint8_t	ch9120_set_dhcp (ch9120_handle_t *handle, ch9120_bool_t enable)
	enable or disable dhcp
uint8_t	ch9120_set_command (ch9120_handle_t *handle, uint8_t *param, uint16_t len, uint8_t *out, uint16_t out_len, uint16_t pre_delay, uint16_t timeout)
	set command

Detailed Description

driver ch9120 header file

Copyright (c) 2015 - present LibDriver All rights reserved

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version

1.0.0

Author

Shifeng Li

Date

2025-09-15

history

Date	Version	Author	Description
2025/09/15	1.0	Shifeng Li	first upload

Definition in file driver_ch9120.h.