udi_usage_cb_t(3udi)

---

Resource indication and trace level control block

SYNOPSIS

#include <udi.h>

typedef struct {

	udi_cb_t gcb;

	udi_trevent_t trace_mask;

	udi_index_t meta_idx;

} udi_usage_cb_t;
 

MEMBERS gcb is a generic control block header, which includes a pointer to the scratch space associated with this control block. The driver may use the scratch space while it owns the control block, but the values are not guaranteed to persist across channel operations.

trace_mask is a bitmask describing the types of trace events that the driver is to report. Setting one of the trace mask bits enables tracing for all events of that type. Some event types are selectable on a metalanguage basis using the meta_idx field.

For the definition of the udi_trevent_t type and the corresponding trace events that may be enabled, see udi_trevent_t on page 17-3 of the UDI Tracing and Logging Chapter.

meta_idx is a metalanguage index that indicates to which metalanguage the metalanguage-selectable trace_mask bits apply. It must match the value of <meta_idx> in the corresponding "meta" declaration of the driver's static driver properties (see Chapter 31), or be zero for the Management Metalanguage.

DESCRIPTION This control block is used with the udi_usage_ind and udi_usage_res operations to indicate the types of events to be traced by the driver and the resource level to which it should comply.

Scratch space size for all Management Metalanguage control blocks is determined by the setting of mgmt_scratch_requirement in the driver's udi_primary_init_t in its udi_init_info. Management Metalanguage control blocks are allocated only by the MA, not by drivers.

REFERENCES udi_cb_t, udi_primary_init_t, udi_init_info, udi_trevent_t, udi_usage_ind, udi_usage_res