xref: /illumos-gate/usr/src/man/man9f/scsi_hba_tran_alloc.9f (revision dd72704bd9e794056c558153663c739e2012d721)
te
Copyright (c) 2006, Sun Microsystems, Inc., All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SCSI_HBA_TRAN_ALLOC 9F "Jan 16, 2006"
NAME
scsi_hba_tran_alloc, scsi_hba_tran_free - allocate and free transport structures
SYNOPSIS
#include <sys/scsi/scsi.h>



scsi_hba_tran_t *scsi_hba_tran_alloc(dev_info_t *dip, int flags);

void scsi_hba_tran_free(scsi_hba_tran_t *hba_tran);
INTERFACE LEVEL
illumos architecture specific (illumos DDI).
PARAMETERS
dip

Pointer to a dev_info structure, defining the HBA driver instance.

flag

Flag modifiers. The only possible flag value is SCSI_HBA_CANSLEEP (memory allocation may sleep).

hba_tran

Pointer to a scsi_hba_tran(9S) structure.

DESCRIPTION
For scsi_hba_tran_alloc():

The scsi_hba_tran_alloc() function allocates a scsi_hba_tran(9S) structure for a HBA driver. The HBA must use this structure to register its transport vectors with the system by using scsi_hba_attach_setup(9F).

If the flag SCSI_HBA_CANSLEEP is set in flags, scsi_hba_tran_alloc() may sleep when allocating resources; otherwise it may not sleep, and callers should be prepared to deal with allocation failures.

For scsi_hba_tran_free():

The scsi_hba_tran_free() function is used to free the scsi_hba_tran(9S) structure allocated by scsi_hba_tran_alloc().

RETURN VALUES
The scsi_hba_tran_alloc() function returns a pointer to the allocated transport structure, or NULL if no space is available.
CONTEXT
The scsi_hba_tran_alloc() function can be called from user, interrupt, or kernel context. Drivers must not allow scsi_hba_tran_alloc() to sleep if called from an interrupt routine.

The scsi_hba_tran_free() function can be called from user, interrupt, or kernel context context.

SEE ALSO
scsi_hba_attach_setup (9F), scsi_hba_tran (9S)

Writing Device Drivers