Tribblix: manual page: usba_alloc_hcdi

USBA_ALLOC_HCDI_OPS(9F) Kernel Functions for Drivers

NAME

usba_alloc_hcdi_ops, usba_free_hcdi_ops - allocate and free USB HCD
interface operations structure

SYNOPSIS

#include <sys/usb/usba/hcdi.h>

usba_hcdi_ops_t *
usba_alloc_hcdi_ops(void);

void
usba_free_hcdi_ops(usba_hcdi_ops_t *ops);

INTERFACE LEVEL

Volatile - illumos USB HCD private function

This is a private function that is not part of the stable DDI. It may
be removed or changed at any time.

PARAMETERS

ops Pointer to an allocated HCD interface operations
structure.

DESCRIPTION

The usba_alloc_hcdi_ops() function allocates a usba_hcdi_ops_t(9S)
structure for use for a USB HCD driver. As part of initialization, a
USB HCD driver will allocate this and fill it in. For more information
on the full lifetime of the object and when a USB HCD driver should
release the structure, see usba_hcdi(9E).

The usba_free_hcdi_ops() function release the memory associated with
the usba_hcdi_ops_t(9S) structure pointed to by ops. Only pointers
received from a call to the usba_alloc_hcdi_ops() function should be
passed to this function.

CONTEXT

These functions are generally called from kernel context during a USB
HCD driver's attach(9E) and detach(9E) entry points. While it is safe
to call this function from user context, it would be quite unusual to
do so.

RETURN VALUES

The usba_alloc_hcdi_ops() function always succeeds and returns a
pointer to an allocation operations structure.