infineon/include/bcmiov.h

3  * Common iovar handling/parsing support - batching, parsing, sub-cmd dispatch etc.
4  * To be used in firmware and host apps or dhd - reducing code size,
9  * Copyright (C) 1999-2017, Broadcom Corporation
18  * permission to link this software with independent modules, and to copy and
30  * <<Broadcom-WL-IPTag/Open:>>
68  * iov validation handler - All the common checks that are required
74 /* iov get handler - process subcommand specific input and return output.
85 /* iov set handler - process subcommand specific input and return output
94 /* iov (sub-cmd) batch - a vector of commands. count can be zero
95  * to support a version query. Each command is a tlv - whose data
102  * Batch sub-commands have status length included in the
112  * +--------+---------+--------+-------+
113  * |version |count    | is_set |sub-cmd|
114  * +--------+---------+--------+-------+
116  * count = number of sub-commands encoded in the iov buf
117  * sub-cmd one or more sub-commands for processing
118  * Where sub-cmd is padded byte buffer with memory layout as follows
119  * +--------+---------+-----------------------+-------------+------
120  * |cmd-id  |length   |IN(options) OUT(status)|command data |......
121  * +--------+---------+-----------------------+-------------+------
122  * cmd-id =sub-command ID
123  * length = length of this sub-command
127  * individual sub-command.
146 /* non-batched command version = major|minor w/ major <= 127 */
165 	BCM_IOV_CMD_FLAG_STATUS_PRESENT = (1 << 0), /* status present at data start - output only */
167 	BCM_IOV_CMD_FLAG_HDR_IN_LEN = (1 << 2), /* length starts at version - non-bacthed only */
175 	bcm_iov_cmd_id_t	cmd;		/* the (sub)command - module specific */
214 /* tlp data for a given tlv - multiple tlvs of same type chained */
238 /* get length callback - default length is min_len taken from digest */
289  * sub-components of a module may register their own commands indepdently
317 /* wlc modules register their iovar(s) using the parsing context w/ wlc layer
330 /* get the maximum number of tlvs - can be used to allocate digest for all
338 /* pack a buffer of uint8s - memcpy wrapper */
345  * pack a buffer with uint16s - serialized in LE order, data points to uint16
352  * pack a buffer with uint32s - serialized in LE order - data points to uint32