Skip to content

Commit

Permalink
library: add sending catalog msgs with prepared argument lists
Browse files Browse the repository at this point in the history 
This adds support for using catalog messages with prepared
argument list. This will be used by the Zephyr v2 logging subsystem
to print catalog messages, as the logging v2 already has prepared
the argument list. There is no need to do any further processing.

Signed-off-by: Daniel Leung <[email protected]>
  • Loading branch information
@dcpleung
dcpleung committed Mar 1, 2022
1 parent d9da086 commit 1dc8bed
Show file tree
Hide file tree
Showing 2 changed files with 175 additions and 0 deletions.
56 changes: 56 additions & 0 deletions library/include/mipi_syst/api.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1807,6 +1807,26 @@ enum mipi_syst_catalog_parameter_types {
##__VA_ARGS__,\
_MIPI_SYST_CATARG_END)

/**
* Send catalog message with a prepare argument list.
*
* This sends catalog messages and its vararg list where the vararg
* list is sent without any processing.
*
* @param svh mipi_syst_handle* SyS-T handle
* @param severity mipi_syst_severity severity level (0..7)
* @param id mipi_syst_u64 catalog ID
* @param args pointer to the prepared argument list
* @param args_sz size of @p args (in bytes)
*/
#define MIPI_SYST_CATALOG64_ARGS_COPY(svh, severity, id, args, args_sz) \
mipi_syst_write_catalog64_args_copy((svh), \
MIPI_SYST_NOLOCATION, \
(severity),\
(id),\
(args),\
(args_sz))

#if defined(MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD)

/**
Expand Down Expand Up @@ -2056,6 +2076,14 @@ mipi_syst_write_printf_catalog64(struct mipi_syst_handle* svh,
enum mipi_syst_severity severity,
mipi_syst_u64 id,
...);

MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
mipi_syst_write_catalog64_args_copy(struct mipi_syst_handle* svh,
struct mipi_syst_msglocation* loc,
enum mipi_syst_severity severity,
mipi_syst_u64 id,
mipi_syst_u8 *args,
size_t args_sz);
#endif /* #if defined(MIPI_SYST_PCFG_ENABLE_PRINTF_API) */

/** @} */
Expand Down Expand Up @@ -2109,6 +2137,27 @@ mipi_syst_write_catalog64_message(struct mipi_syst_handle* svh,
##__VA_ARGS__,\
_MIPI_SYST_CATARG_END)

/**
* Send catalog message with a prepared argument list.
*
* This sends catalog messages and its vararg list where the vararg
* list is sent without any processing.
*
* @param svh mipi_syst_handle* SyS-T handle
* @param severity mipi_syst_severity severity level (0..7)
* @param id mipi_syst_u32 catalog ID
* @param args pointer to the prepared argument list
* @param args_sz size of @p args (in bytes)
*/
#define MIPI_SYST_CATALOG32_ARGS_COPY(svh, severity, id, args, args_sz) \
mipi_syst_write_catalog32_args_copy((svh), \
MIPI_SYST_NOLOCATION, \
(severity),\
(id),\
(args),\
(args_sz))


#if defined(MIPI_SYST_PCFG_ENABLE_LOCATION_RECORD)

/**
Expand Down Expand Up @@ -2339,6 +2388,13 @@ mipi_syst_write_printf_catalog32(struct mipi_syst_handle* svh,
mipi_syst_u32 id,
...);

MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
mipi_syst_write_catalog32_args_copy(struct mipi_syst_handle* svh,
struct mipi_syst_msglocation* loc,
enum mipi_syst_severity severity,
mipi_syst_u32 id,
mipi_syst_u8 *args,
size_t args_sz);
#endif /* defined(MIPI_SYST_PCFG_ENABLE_PRINTF_API) */

/** @copydoc MIPI_SYST_CATALOG64_0 */
Expand Down
119 changes: 119 additions & 0 deletions library/src/mipi_syst_api.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1253,6 +1253,65 @@ MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
/* call IO routine to dump out the message */
MIPI_SYST_SCATTER_WRITE(svh, prog, &desc);
}

/**
* Write a printf catalog message with 64bit ID using a prepared arg list
*
* @param svh SyS-T handle
* @param loc Pointer to instrumentation location or null if no location
* @param severity severity level (0..7)
* @param args pointer to prepared argument list
* @param args_sz size of @p args (in bytes)
*/
MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
mipi_syst_write_catalog64_args_copy(struct mipi_syst_handle* svh,
struct mipi_syst_msglocation* loc,
enum mipi_syst_severity severity,
mipi_syst_u64 id,
mipi_syst_u8 *args,
size_t args_sz)
{
mipi_syst_u8 argBuf[MIPI_SYST_PCFG_PRINTF_ARGBUF_SIZE+sizeof(id)];
int len;
struct mipi_syst_msgdsc desc;
struct mipi_syst_scatter_prog prog[MIPI_SYST_SCATTER_PROG_LEN];
struct mipi_syst_scatter_prog *prog_ptr = prog;

if ((struct mipi_syst_handle*)0 == svh)
return;

if (args_sz >= MIPI_SYST_PCFG_PRINTF_ARGBUF_SIZE)
return;

/* assign tag */
desc.ed_tag = svh->systh_tag;
desc.ed_tag.et_type = MIPI_SYST_TYPE_CATALOG;
#if defined(MIPI_SYST_PCFG_ENABLE_64BIT_ADDR)
desc.ed_tag.et_subtype = MIPI_SYST_CATALOG_ID64_P64;
#else
desc.ed_tag.et_subtype = MIPI_SYST_CATALOG_ID64_P32;
#endif
desc.ed_tag.et_severity = severity;

memcpy(argBuf+sizeof(id), args, args_sz);

*(mipi_syst_u64*)argBuf = MIPI_SYST_HTOLE64(id);

len = sizeof(id) + args_sz;

insert_optional_msg_components(svh, loc, (mipi_syst_u16)len, &desc, &prog_ptr);

*prog_ptr = scatter_ops[SCATTER_OP_PAYLD_VAR];
desc.ed_pld.data_var = (const mipi_syst_u8 *) argBuf;
prog_ptr->sso_length = (mipi_syst_u16)len;
++prog_ptr;
*prog_ptr = scatter_ops[SCATTER_OP_END];

ASSERT_CHECK(prog_ptr < &prog[MIPI_SYST_SCATTER_PROG_LEN]);

/* call IO routine to dump out the message */
MIPI_SYST_SCATTER_WRITE(svh, prog, &desc);
}
#endif // #if defined(MIPI_SYST_PCFG_ENABLE_CATID64_API)
#if defined(MIPI_SYST_PCFG_ENABLE_CATID32_API)

Expand Down Expand Up @@ -1330,5 +1389,65 @@ MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
/* call IO routine to dump out the message */
MIPI_SYST_SCATTER_WRITE(svh, prog, &desc);
}

/**
* Write a printf catalog message with 32bit ID using a prepared argument list
*
* @param svh SyS-T handle
* @param loc Pointer to instrumentation location or null if no location
* @param severity severity level (0..7)
* @param id catalog id
* @param args pointer to prepared argument list
* @param args_sz size of @p args (in bytes)
*/
MIPI_SYST_EXPORT void MIPI_SYST_CALLCONV
mipi_syst_write_catalog32_args_copy(struct mipi_syst_handle* svh,
struct mipi_syst_msglocation* loc,
enum mipi_syst_severity severity,
mipi_syst_u32 id,
mipi_syst_u8 *args,
size_t args_sz)
{
mipi_syst_u8 argBuf[MIPI_SYST_PCFG_PRINTF_ARGBUF_SIZE+sizeof(id)];
int len;
struct mipi_syst_msgdsc desc;
struct mipi_syst_scatter_prog prog[MIPI_SYST_SCATTER_PROG_LEN];
struct mipi_syst_scatter_prog *prog_ptr = prog;

if ((struct mipi_syst_handle*)0 == svh)
return;

if (args_sz >= MIPI_SYST_PCFG_PRINTF_ARGBUF_SIZE)
return;

/* assign tag */
desc.ed_tag = svh->systh_tag;
desc.ed_tag.et_type = MIPI_SYST_TYPE_CATALOG;
#if defined(MIPI_SYST_PCFG_ENABLE_64BIT_ADDR)
desc.ed_tag.et_subtype = MIPI_SYST_CATALOG_ID32_P64;
#else
desc.ed_tag.et_subtype = MIPI_SYST_CATALOG_ID32_P32;
#endif
desc.ed_tag.et_severity = severity;

memcpy(argBuf+sizeof(id), args, args_sz);

*(mipi_syst_u32*)argBuf = MIPI_SYST_HTOLE32(id);

len = sizeof(id) + args_sz;

insert_optional_msg_components(svh, loc, (mipi_syst_u16)len, &desc, &prog_ptr);

*prog_ptr = scatter_ops[SCATTER_OP_PAYLD_VAR];
desc.ed_pld.data_var = (const mipi_syst_u8 *) argBuf;
prog_ptr->sso_length = (mipi_syst_u16)len;
++prog_ptr;
*prog_ptr = scatter_ops[SCATTER_OP_END];

ASSERT_CHECK(prog_ptr < &prog[MIPI_SYST_SCATTER_PROG_LEN]);

/* call IO routine to dump out the message */
MIPI_SYST_SCATTER_WRITE(svh, prog, &desc);
}
#endif // #if defined(MIPI_SYST_PCFG_ENABLE_CATID32_API)
#endif /* #if defined(MIPI_SYST_PCFG_ENABLE_PRINTF_API) */

0 comments on commit 1dc8bed

Please sign in to comment.