DriverUtils

This module provides interfaces such as log printing, doubly linked list operations, and work queues.

Since:

1.0

Version:

1.0

Summary

Files

Data Structures

Data Structure Name	Description
	Describes a doubly linked list.
HdfWork	Describes a work item and a delayed work item. This structure defines the work and delayed work items, and then calls the initialization function or HdfDelayedWorkInit to perform initialization. The function is to add a work item to a work queue immediately, and the HdfAddDelayedWork() function is to add a work item to a work queue after the configured delayed time.
	Describes a work queue.

Macros

Macro Name and Value	Description
HDF_WAIT_FOREVER 0xFFFFFFFF	Indicates that the function keeps waiting to obtain a semaphore or mutex.
HDF_ARRAY_SIZE (a) (sizeof(a) / sizeof((a)[0]))	Defines the array size.
HDF_KILO_UNIT 1000	Defines a time conversion unit, for example, the unit for converting from second to millisecond.
CONTAINER_OF(ptr, type, member) (type )((char )(ptr) - (char )&((type )0)->member)	Obtains the address of a structure variable from its member address.
(ptr, type, member) CONTAINER_OF((ptr)->next, type, member)	Obtains the first node of a doubly linked list.
(ptr, type, member) CONTAINER_OF((ptr)->prev, type, member)	Obtains the last node of a doubly linked list.
(pos, head, type, member)	Traverses all nodes in a doubly linked list.
DLIST_FOR_EACH_ENTRY_SAFE(pos, tmp, head, type, member)	Traverses all nodes in a doubly linked list. This function is used to delete the nodes pointed to by pos during traversal.
(HDF_TAG) #HDF_TAG
HDF_LOGV(fmt, arg…) (“[HDF:V/“ LOG_TAG “]” fmt “\r\n”, ##arg)	Prints logs at the verbose level.
HDF_LOGD(fmt, arg…) (“[HDF:D/“ LOG_TAG “]” fmt “\r\n”, ##arg)	Prints logs at the debug level.
HDF_LOGI(fmt, arg…) (“[HDF:I/“ LOG_TAG “]” fmt “\r\n”, ##arg)	Prints logs at the information level.
HDF_LOGW(fmt, arg…) (“[HDF:W/“ LOG_TAG “]” fmt “\r\n”, ##arg)	Prints logs at the warning level.
HDF_LOGE(fmt, arg…) (“[HDF:E/“ LOG_TAG “]” fmt “\r\n”, ##arg)	Prints logs at the error level.

Typedefs

Typedef Name	Description
HdfWorkFunc) (void )	typedef void( Describes a work execution function type.

Typedef Name

Description

HdfWorkFunc) (void )

typedef void(

Describes a work execution function type.

Enumerations

Enumeration Name	Description
{ HDF_SUCCESS = 0, = -1, HDF_ERR_NOT_SUPPORT = -2, = -3, HDF_ERR_INVALID_OBJECT = -4, = -6, HDF_ERR_TIMEOUT = -7, = -10, HDF_ERR_QUEUE_FULL = -15, = -16, HDF_ERR_IO = -17, = -18, HDF_BSP_ERR_OP = HDF_BSP_ERR_NUM(-1), = HDF_BSP_ERR_NUM(-2), HDF_PAL_ERR_DEV_CREATE = HDF_BSP_ERR_NUM(-3), = HDF_BSP_ERR_NUM(-4), HDF_DEV_ERR_NO_MEMORY = HDF_DEV_ERR_NUM(-1), = HDF_DEV_ERR_NUM(-2), HDF_DEV_ERR_NO_DEVICE_SERVICE = HDF_DEV_ERR_NUM(-3), = HDF_DEV_ERR_NUM(-4), HDF_DEV_ERR_PUBLISH_FAIL = HDF_DEV_ERR_NUM(-5), = HDF_DEV_ERR_NUM(-6), HDF_DEV_ERR_NODATA = HDF_DEV_ERR_NUM(-7), = HDF_DEV_ERR_NUM(-8), HDF_DEV_ERR_OP = HDF_DEV_ERR_NUM(-10) }	Enumerates HDF return value types.
{ = 1 << 0, HDF_WORK_BUSY_RUNNING = 1 << 1 }	Enumerates statuses of a work item or a delayed work item.

Enumeration Name

Description

{ HDF_SUCCESS = 0, = -1, HDF_ERR_NOT_SUPPORT = -2, = -3, HDF_ERR_INVALID_OBJECT = -4, = -6, HDF_ERR_TIMEOUT = -7, = -10, HDF_ERR_QUEUE_FULL = -15, = -16, HDF_ERR_IO = -17, = -18, HDF_BSP_ERR_OP = HDF_BSP_ERR_NUM(-1), = HDF_BSP_ERR_NUM(-2), HDF_PAL_ERR_DEV_CREATE = HDF_BSP_ERR_NUM(-3), = HDF_BSP_ERR_NUM(-4), HDF_DEV_ERR_NO_MEMORY = HDF_DEV_ERR_NUM(-1), = HDF_DEV_ERR_NUM(-2), HDF_DEV_ERR_NO_DEVICE_SERVICE = HDF_DEV_ERR_NUM(-3), = HDF_DEV_ERR_NUM(-4), HDF_DEV_ERR_PUBLISH_FAIL = HDF_DEV_ERR_NUM(-5), = HDF_DEV_ERR_NUM(-6), HDF_DEV_ERR_NODATA = HDF_DEV_ERR_NUM(-7), = HDF_DEV_ERR_NUM(-8), HDF_DEV_ERR_OP = HDF_DEV_ERR_NUM(-10) }

Enumerates HDF return value types.

{ = 1 << 0, HDF_WORK_BUSY_RUNNING = 1 << 1 }

Enumerates statuses of a work item or a delayed work item.

Functions

Function Name	Description
(struct DListHead head)	static void Initializes a doubly linked list.
(const struct DListHead head)	static bool Checks whether a doubly linked list is empty.
(struct DListHead )	static void Removes a node from a doubly linked list.
DListInsertHead (struct entry, struct head)	static void Inserts a node from the head of a doubly linked list.
DListInsertTail (struct entry, struct head)	static void Inserts a node from the tail of a doubly linked list.
DListMerge (struct list, struct DListHead head)	static void Merges two linked lists by adding the list specified by list to the head of the list specified by head and initializes the merged list.
(HdfWorkQueue queue, char name)	int32_t Initializes a work queue.
(HdfWork work, func, void arg)	int32_t Initializes a work item.
HdfDelayedWorkInit ( work, HdfWorkFunc func, void arg)	int32_t Initializes a delayed work item.
(HdfWork work)	void Destroys a work item.
(HdfWorkQueue queue)	void Destroys a work queue.
(HdfWork work)	void Destroys a delayed work item.
(HdfWorkQueue queue, work)	bool Adds a work item to a work queue.
HdfAddDelayedWork ( queue, HdfWork work, unsigned long ms)	bool Adds a delayed work item to a work queue.
(HdfWork work)	unsigned int Obtains the status of a work item or delayed work item.
(HdfWork work)	bool Cancels a work item. This function waits until the work item is complete.
	bool Cancels a delayed work item.

Details

Macro Definition Documentation

CONTAINER_OF

Description:

Obtains the address of a structure variable from its member address.

Parameters:

Name	Description
ptr	Indicates the structure member address.
type	Indicates the structure type.
member	Indicates the structure member.

DLIST_FIRST_ENTRY

Description:

Obtains the first node of a doubly linked list.

Parameters:

Name	Description
ptr	Indicates the structure member address.
type	Indicates the structure type.
member	Indicates the structure member.

DLIST_FOR_EACH_ENTRY

#define DLIST_FOR_EACH_ENTRY( pos,  head,  type,  member )

Values: for ((pos) = [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((head)->next, type, member); \
 &(pos)->member != (head); \
 (pos) = [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((pos)->member.next, type, member))

Description:

Traverses all nodes in a doubly linked list.

Parameters:

Name	Description
pos	Indicates the pointer to the structure variable.
head	Indicates the pointer to the linked list head.
type	Indicates the structure type.
member	Indicates the member type of the structure.

DLIST_FOR_EACH_ENTRY_SAFE

#define DLIST_FOR_EACH_ENTRY_SAFE( pos,  tmp,  head,  type,  member )

Values: for ((pos) = [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((head)->next, type, member), \
 (tmp) = [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((pos)->member.next, type, member); \
 &(pos)->member != (head); \
 (pos) = (tmp), (tmp) = [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((pos)->member.next, type, member))

Description:

Traverses all nodes in a doubly linked list. This function is used to delete the nodes pointed to by pos during traversal.

Parameters:

Name	Description
pos	Indicates the pointer to the structure variable.
tmp	Indicates the pointer to the structure variable, pointing to the next node of pos.
head	Indicates the pointer to the linked list head.
type	Indicates the structure type.
member	Indicates the member type of the structure.

#define DLIST_LAST_ENTRY( ptr,  type,  member )   [CONTAINER_OF]($api-api-SmartVision-Devices-DriverUtils.md#ga818b9cca761fe7bc18e4e417da772976)((ptr)->prev, type, member)

Description:

Obtains the last node of a doubly linked list.

Parameters:

Name	Description
ptr	Indicates the structure member address.
type	Indicates the structure type.
member	Indicates the structure member.