udi_gio_diag_params_t(3udi)


Parameters for standard GIO diagnostic ops

SYNOPSIS

#include <udi.h>

typedef struct {

	udi_ubit8_t test_num;

	udi_ubit8_t test_params_size;

} udi_gio_diag_params_t;
 

MEMBERS test_num is the number of the diagnostic test to run. This value is ignored if the op member of the gio_xfer_cb is not set to UDI_GIO_OP_DIAG_RUN_TEST.

test_params_size is the number of bytes of additional parameters, if any, for the test specified by test_num. This number may be zero, and must not be greater than two less than the params_size specified in udi_gio_xfer_cb_init. The semantics and structure of these additional parameters are defined by each driver; the corresponding params_layout must include the structure of the additional parameters. This value is ignored if the op member of the gio_xfer_cb is not set to UDI_GIO_OP_DIAG_RUN_TEST.

DESCRIPTION This structure is used to hold additional parameters for the GIO device diagnostics operation UDI_GIO_OP_DIAG_RUN_TEST. It is passed to a udi_gio_xfer_req operation using the tr_params inline array of the udi_gio_xfer_cb_t.

The tr_params pointer itself must not be changed; instead it should be cast to (udi_gio_diag_params_t *) and then the structure may be read or written through the resulting pointer.

Any control block allocated for use with udi_gio_diag_params_t must result from a udi_gio_xfer_cb_init call with params_size set to at least sizeof(udi_gio_diag_params_t).

REFERENCES udi_gio_xfer_cb_t, udi_gio_xfer_req, udi_gio_xfer_ack, udi_gio_xfer_cb_init


UDI Core Specification Contents