hba/ghd/ghd_waitq.h

	ghd_waitq.h revision 507c32411f3f101e90ca2120f042b5ee698ba1d5
/*
 * CDDL HEADER START
 *
 * 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]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#ifndef _GHD_WAITQ_H
#define _GHD_WAITQ_H

#pragma ident   "%Z%%M% %I% %E% SMI"

#ifdef  __cplusplus
extern "C" {
#endif


/*
 * there's a waitq_t per target device and one per HBA
 */

typedef struct ghd_q {
    struct ghd_q *Q_nextp;  /* ptr to next level of queuing */
    L2el_t  Q_qhead;    /* Q of waiting gcmds */
    long    Q_nactive;  /* current # of outstanding gcmds */
    long    Q_maxactive;    /* max gcmds to release concurrently */
} Q_t;

#define GHD_WAITQ_INIT(qp, nxtp, maxactive) \
    (L2_INIT(&(qp)->Q_qhead),       \
    (qp)->Q_nextp = (nxtp),         \
    (qp)->Q_nactive = 0,            \
    (qp)->Q_maxactive = (maxactive))
/*
 * one per target device
 */
typedef struct ghd_device {
    Q_t gd_waitq;   /* the queue structure for this device */
    L1el_t  gd_devlist; /* all gdevs for a HBA are linked together */
    ulong_t gd_target;  /*  ... and are located by searching for */
    ulong_t gd_lun;     /*  ... a match on the (target,lun) values */

    L1_t    gd_ilist;   /* linked list of instances for this device */
    ulong_t gd_ninstances;  /* # of instances for this device */
} gdev_t;

#define GDEV_QHEAD(gdevp)   ((gdevp)->gd_waitq.Q_qhead)
#define GDEV_NACTIVE(gdevp) ((gdevp)->gd_waitq.Q_nactive)
#define GDEV_MAXACTIVE(gdevp)   ((gdevp)->gd_waitq.Q_maxactive)

/*
 * Be careful, this macro assumes there's a least one
 * target instance attached to this dev structure, Otherwise, l1_headp
 * is NULL.
 */
#define GDEVP2GTGTP(gdevp)  \
    (gtgt_t *)((gdevp)->gd_ilist.l1_headp->le_datap)

#define GDEV_NEXTP(gdevp)                       \
    ((gdevp)->gd_devlist.le_nextp                   \
        ? (gdev_t *)((gdevp)->gd_devlist.le_nextp->le_datap)    \
        : (gdev_t *)NULL)

#define GDEV_QATTACH(gdevp, cccp, max)  {               \
    GHD_WAITQ_INIT(&(gdevp)->gd_waitq, &(cccp)->ccc_waitq, (max));  \
    L1EL_INIT(&gdevp->gd_devlist);                  \
    L1HEADER_INIT(&gdevp->gd_ilist);                \
    /* add the per device structure to the HBA's device list */ \
    L1_add(&(cccp)->ccc_devs, &(gdevp)->gd_devlist, (gdevp));   \
}

#define GDEV_QDETACH(gdevp, cccp)           \
    L1_delete(&(cccp)->ccc_devs, &(gdevp)->gd_devlist)

/*
 * GHD target structure, one per attached target driver instance
 */
typedef struct  ghd_target_instance {
    L1el_t   gt_ilist;  /* list of other instances for this device */
    gdev_t  *gt_gdevp;  /* ptr to info shared by all instances */

    /* this would be ccc_t, but is circular with ghd.h.  sigh. */
    struct cmd_ctl *gt_ccc; /* ptr to HBA per-instance struct */

    ulong_t  gt_maxactive;  /* max gcmds to release concurrently */
    void    *gt_hba_private; /* ptr to soft state of this HBA instance */
    void    *gt_tgt_private; /* ptr to soft state of this target instance */
    size_t   gt_size;   /* size including tgt_private */
    ushort_t gt_target; /* target number of this instance */
    uchar_t  gt_lun;    /* LUN of this instance */
} gtgt_t;

#define GTGTP2TARGET(gtgtp) ((gtgtp)->gt_tgt_private)
#define GTGTP2HBA(gtgtp)    ((gtgtp)->gt_hba_private)
#define GTGTP2GDEVP(gtgtp)  ((gtgtp)->gt_gdevp)

#define GTGT_INIT(gtgtp)    L1EL_INIT(&(gtgtp)->gt_ilist)

/* Add the per instance structure to the per device list  */
#define GTGT_ATTACH(gtgtp, gdevp)   {               \
    (gdevp)->gd_ninstances++;                   \
    L1_add(&(gdevp)->gd_ilist, &(gtgtp)->gt_ilist, (gtgtp));    \
}


/* remove this per-instance-structure from the device list */
#define GTGT_DEATTACH(gtgtp, gdevp) {           \
    (gdevp)->gd_ninstances--;               \
    L1_delete(&(gdevp)->gd_ilist, &(gtgtp)->gt_ilist);  \
}

#ifdef  __cplusplus
}
#endif
#endif  /* _GHD_QUEUE_H */