25cf1a301a396c38e8adf52c15f537b80d2483f7jl/*
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * CDDL HEADER START
25cf1a301a396c38e8adf52c15f537b80d2483f7jl *
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * The contents of this file are subject to the terms of the
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * Common Development and Distribution License (the "License").
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * You may not use this file except in compliance with the License.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl *
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * or http://www.opensolaris.org/os/licensing.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * See the License for the specific language governing permissions
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * and limitations under the License.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl *
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * When distributing Covered Code, include this CDDL HEADER in each
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * If applicable, add the following below this CDDL HEADER, with the
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * fields enclosed by brackets "[]" replaced with your own identifying
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * information: Portions Copyright [yyyy] [name of copyright owner]
25cf1a301a396c38e8adf52c15f537b80d2483f7jl *
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * CDDL HEADER END
25cf1a301a396c38e8adf52c15f537b80d2483f7jl */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl/*
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * Use is subject to license terms.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#ifndef _SYS_OPLKM_H
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define _SYS_OPLKM_H
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#pragma ident "%Z%%M% %I% %E% SMI"
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#ifdef __cplusplus
25cf1a301a396c38e8adf52c15f537b80d2483f7jlextern "C" {
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#endif
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl/*
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * Device instance structure.
25cf1a301a396c38e8adf52c15f537b80d2483f7jl */
25cf1a301a396c38e8adf52c15f537b80d2483f7jltypedef struct okms {
25cf1a301a396c38e8adf52c15f537b80d2483f7jl dev_info_t *km_dip; /* Devinfo pointer */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl major_t km_major; /* Major number */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl uint32_t km_inst; /* Device instance */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl mkey_t km_key; /* Mailbox key */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl target_id_t km_target; /* Target-id */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl ddi_iblock_cookie_t km_ibcookie; /* Interrupt block cookie */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl kmutex_t km_lock; /* Lock to protect this structure */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl kcondvar_t km_wait; /* Cond. var to signal events */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl uint32_t km_state; /* State of the device */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl uint32_t km_maxsz; /* Max msg size */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl uint32_t km_retries; /* Number of retries */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl uint32_t km_clean; /* Cleanup flags */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl mscat_gath_t km_sg_rcv; /* Scatter-gather for Rx */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl mscat_gath_t km_sg_tx; /* Scatter-gather for Tx */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl okm_req_hdr_t *km_reqp; /* Cached request */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl int km_reqlen; /* Request length */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl} okms_t;
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl/* km_state flags */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_MB_INITED 0x00000001 /* Mailbox initialized */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_MB_CONN 0x00000002 /* Mailbox in connected state */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_MB_DISC 0x00000004 /* Mailbox is disconnected */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_OPENED 0x00000008 /* Device opened */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_MBOX_READY(x) (((x)->km_state & OKM_MB_CONN) && \
25cf1a301a396c38e8adf52c15f537b80d2483f7jl !((x)->km_state & OKM_MB_DISC))
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl/* km_clean flags */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_CLEAN_LOCK 0x00000001
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_CLEAN_CV 0x00000002
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define OKM_CLEAN_NODE 0x00000004
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#ifdef DEBUG
25cf1a301a396c38e8adf52c15f537b80d2483f7jl/*
25cf1a301a396c38e8adf52c15f537b80d2483f7jl * Debug levels
25cf1a301a396c38e8adf52c15f537b80d2483f7jl */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DBG_DRV 0x01 /* driver related traces */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DBG_MBOX 0x02 /* Mailbox traces */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DBG_MESG 0x04 /* Mailbox Message traces */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DBG_WARN 0x10 /* warning type traces */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jlstatic void okm_print_req(okm_req_hdr_t *reqp, uint32_t len);
25cf1a301a396c38e8adf52c15f537b80d2483f7jlstatic void okm_print_rep(okm_rep_hdr_t *repp);
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DPRINTF(f, x) if (f & okm_debug) printf x
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DUMP_REQ(r, l) okm_print_req(r, l)
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DUMP_REPLY(r) okm_print_rep(r)
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#else /* DEBUG */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DPRINTF(f, x)
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DUMP_REQ(r, l)
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#define DUMP_REPLY(r)
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#endif /* DEBUG */
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#ifdef __cplusplus
25cf1a301a396c38e8adf52c15f537b80d2483f7jl}
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#endif
25cf1a301a396c38e8adf52c15f537b80d2483f7jl
25cf1a301a396c38e8adf52c15f537b80d2483f7jl#endif /* _SYS_OPLKM_H */