123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208 |
- /* SPDX-License-Identifier: GPL-2.0+ */
- /*
- * Data Path Soft Parser API
- *
- * Copyright 2018 NXP
- */
- #ifndef _FSL_DPSPARSER_H
- #define _FSL_DPSPARSER_H
- /* DPSPARSER last supported API version */
- #define DPSPARSER_VER_MAJOR 1
- #define DPSPARSER_VER_MINOR 0
- /* Command IDs */
- #define DPSPARSER_CMDID_CLOSE 0x8001
- #define DPSPARSER_CMDID_OPEN 0x8111
- #define DPSPARSER_CMDID_CREATE 0x9111
- #define DPSPARSER_CMDID_DESTROY 0x9911
- #define DPSPARSER_CMDID_GET_API_VERSION 0xa111
- #define DPSPARSER_CMDID_APPLY_SPB 0x1181
- /* cmd, param, offset, width, type, arg_name */
- #define DPSPARSER_CMD_BLOB_SET_ADDR(cmd, addr) \
- MC_CMD_OP(cmd, 0, 0, 64, u64, addr)
- /* cmd, param, offset, width, type, arg_name */
- #define DPSPARSER_CMD_BLOB_REPORT_ERROR(cmd, err) \
- MC_RSP_OP(cmd, 0, 0, 16, u16, err)
- /* Data Path Soft Parser API
- * Contains initialization APIs and runtime control APIs for DPSPARSER
- */
- struct fsl_mc_io;
- /* MC Unknown error: */
- #define MC_ERROR_MSG_SPB_UNKNOWN "Unknown MC error\n"
- /* MC Error messages (in order for each error code defined above): */
- #define MC_ERROR_MSG_APPLY_SPB \
- { \
- "OK\n", \
- "BLOB : Magic number does not match\n", \
- "BLOB : Version does not match MC API version\n", \
- "BLOB : IP revision does not match HW revision\n", \
- "BLOB : Blob length is not a multiple of 4\n", \
- "BLOB : Invalid length detected\n", \
- "BLOB : Name length < 0 in 'blob-name'\n", \
- "BLOB : Name length not a 4 multiple in 'blob-name'\n", \
- "BLOB : No target HW parser selected\n", \
- "BLOB : SP size is negative\n", \
- "BLOB : Size is zero\n", \
- "BLOB : Number of protocols is negative\n", \
- "BLOB : Zero protocols\n", \
- "BLOB : Protocol name is null\n", \
- "BLOB : SP 'seq-start' is not in [0x40, 0xffc0) range\n", \
- "BLOB : Invalid base protocol\n", \
- "BLOB : Invalid parameters section\n", \
- "BLOB : Invalid parameter\n", \
- "BLOB : Invalid parameter configuration\n", \
- "BLOB : Not aligned value\n", \
- "BLOB : Invalid section TAG detected\n", \
- "BLOB : Section size is zero\n", \
- "BLOB : Section size not a 4 multiple\n", \
- "BLOB : Section size is too big\n", \
- "BLOB : No 'bytecode' section before\n", \
- "BLOB : No 'sp-protocols' section before\n", \
- "BLOB : No 'bytecode' section defined\n", \
- "BLOB : No 'sp-protocols' section defined\n", \
- "BLOB : Soft Parser BLOB parsing : Error detected\n", \
- "apply spb : Soft Parser BLOB is already applied\n", \
- "apply spb : BLOB address is not set\n", \
- "BLOB : SP parameter offset is not a 4 multiple\n", \
- "BLOB : SP parameter offset can't be less than 0x40\n", \
- "BLOB : Bytecode size is not a 4 multiple\n", \
- "BLOB : Bytecode size cannot be zero\n", \
- "BLOB : Bytecode can't overwrite the 0xFFE address\n", \
- "BLOB : No hardware parser selected as target\n", \
- "BLOB : Bytecode overlap detected\n", \
- "BLOB : No parser support\n", \
- "BLOB : Too many bytecode sections on WRIOP ingress\n", \
- "BLOB : Too many bytecode sections on WRIOP egress\n", \
- "BLOB : Too many bytecode sections on AIOP\n", \
- "BLOB : Duplicated protocol is already registered\n", \
- "BLOB : Maximum number of allowed protocols was exceeded\n", \
- "BLOB : Protocols limit exceeded\n", \
- "BLOB : Protocol is linked twice\n", \
- "BLOB : Soft parser is linked twice\n", \
- "BLOB : Parameter offset exceeds the maximum parameters limit\n", \
- "BLOB : Parameter size can't be 0 or greater than 64\n", \
- "BLOB : Parameter offset plus size exceeds the maximum limit\n", \
- "BLOB : Parameters number exceeds the maximum limit\n", \
- "BLOB : Duplicated parameter name\n", \
- "BLOB : Parameters overlapped detected\n", \
- "apply spb : No dpsparser handle.\n", \
- \
- MC_ERROR_MSG_SPB_UNKNOWN, \
- NULL, \
- }
- /**
- * dpsparser_open() - Open a control session for the specified object.
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @token: Returned token; use in subsequent API calls
- *
- * This function can be used to open a control session for an
- * already created object; an object may have been declared in
- * the DPL or by calling the dpsparser_create function.
- * This function returns a unique authentication token,
- * associated with the specific object ID and the specific MC
- * portal; this token must be used in all subsequent commands for
- * this specific object
- *
- * Return: '0' on Success; Error code otherwise.
- */
- int dpsparser_open(struct fsl_mc_io *mc_io,
- u32 cmd_flags,
- u16 *token);
- /**
- * dpsparser_close() - Close the control session of the object
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @token: Token of DPSPARSER object
- *
- * After this function is called, no further operations are
- * allowed on the object without opening a new control session.
- *
- * Return: '0' on Success; Error code otherwise.
- */
- int dpsparser_close(struct fsl_mc_io *mc_io,
- u32 cmd_flags,
- u16 token);
- /**
- * dpsparser_create() - Create the DPSPARSER object.
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @token: Returned token; use in subsequent API calls
- *
- * Create the DPSPARSER object, allocate required resources and
- * perform required initialization.
- *
- * The object can be created either by declaring it in the
- * DPL file, or by calling this function.
- * This function returns a unique authentication token,
- * associated with the specific object ID and the specific MC
- * portal; this token must be used in all subsequent calls to
- * this specific object. For objects that are created using the
- * DPL file, call dpsparser_open function to get an authentication
- * token first.
- *
- * Return: '0' on Success; Error code otherwise.
- */
- int dpsparser_create(struct fsl_mc_io *mc_io,
- u16 token,
- u32 cmd_flags,
- u32 *obj_id);
- /**
- * dpsparser_destroy() - Destroy the DPSPARSER object and release all its
- * resources.
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @token: Token of DPSPARSER object
- *
- * Return: '0' on Success; error code otherwise.
- */
- int dpsparser_destroy(struct fsl_mc_io *mc_io,
- u16 token,
- u32 cmd_flags,
- u32 obj_id);
- /**
- * dpsparser_apply_spb() - Applies the Soft Parser Blob loaded at specified
- * address.
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @token: Token of DPSPARSER object
- * @blob_addr: Blob loading address
- * @error: Error reported by MC related to SP Blob parsing and apply
- *
- * Return: '0' on Success; error code otherwise.
- */
- int dpsparser_apply_spb(struct fsl_mc_io *mc_io,
- u32 cmd_flags,
- u16 token,
- u64 blob_addr,
- u16 *error);
- /**
- * dpsparser_get_api_version - Retrieve DPSPARSER Major and Minor version info.
- *
- * @mc_io: Pointer to MC portal's I/O object
- * @cmd_flags: Command flags; one or more of 'MC_CMD_FLAG_'
- * @major_ver: DPSPARSER major version
- * @minor_ver: DPSPARSER minor version
- *
- * Return: '0' on Success; Error code otherwise.
- */
- int dpsparser_get_api_version(struct fsl_mc_io *mc_io,
- u32 cmd_flags,
- u16 *major_ver,
- u16 *minor_ver);
- #endif /* _FSL_DPSPARSER_H */
|