9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CDDL HEADER START
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The contents of this file are subject to the terms of the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Common Development and Distribution License (the "License").
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * You may not use this file except in compliance with the License.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * See the License for the specific language governing permissions
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * and limitations under the License.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * When distributing Covered Code, include this CDDL HEADER in each
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If applicable, add the following below this CDDL HEADER, with the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * fields enclosed by brackets "[]" replaced with your own identifying
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * information: Portions Copyright [yyyy] [name of copyright owner]
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CDDL HEADER END
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Use is subject to license terms.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Contains all of the prototypes, #defines, and structures necessary
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * for all of the Tavor Infiniband Management Agent (SMA, PMA, BMA)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Specifically it contains the various flags, structures used for tracking
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the Tavor agents, and prototypes for initialization and teardown
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * functions.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following defines specify the default number of (SW-assisted) agents
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * per port. It is broken down by QP number. QP0 will have only the one
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * agent, the SMA. QP1 should have two agents, the PMA and BMA, but for now
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the Tavor firmware doesn't support a BMA. So we do not register it with
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* Number of threads for the agent handling task queue */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* Maximum number of tasks on task queue */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following defines the name for the task queue. Note: this string
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * will later be combined with the Tavor driver instance number to create
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * a unique name for the task queue
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following macros are used when handling directed route MADs. They tell
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the driver whether a given MAD is a directed route MAD, can extract the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * "hop pointer" and "hop count" fields, and can even set the "direction" bit
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * in the MAD and (if necessary) update the "hop pointer".
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * More details on how these macros are used can be found in the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (((sm_dr_mad_hdr_t *)(madhdrp))->MgmtClass == 0x81)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#define TAVOR_DRMAD_SET_HOPPOINTER(madhdrp, hp) \
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (((sm_dr_mad_hdr_t *)(madhdrp))->HopPointer = (hp))
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (((sm_dr_mad_hdr_t *)(madhdrp))->D_Status |= 0x0080)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor (((sm_dr_mad_hdr_t *)(madhdrp))->D_Status |= 0x8000)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following macro is used to determine whether a received MAD is
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * one of the special "Tavor Trap" MADs. If it is, then some special
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * processing (described in tavor_agents.c) is necessary.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ((((msgp)->im_msgbufs_recv.im_bufs_mad_hdr->R_Method & \
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following macro is used to determine whether a received MAD is
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * a "TrapRepress" MAD. If it is, then no response MAD should be sent
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * (described in tavor_agents.c).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor ((((msgp)->im_msgbufs_recv.im_bufs_mad_hdr->R_Method & \
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The following define specified the offset for the start of "Return Path"
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * in a directed route MAD. Note: this is the offset from the start of the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * MAD data area (in bytes).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The tavor_agent_list_s structure is used in the Tavor IB Management Agent
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * routines to keep track of the number (and type) of each register agent.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The primary purpose of tracking this information (port number, management
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * class, and IBMF handle) is to be able to later deregister all the agents
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * which are registered at attach() time. Note: a pointer to this structure
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * is returned to the driver (by the IBMF) every time the agent callback
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * routine is called. This is why the structure contains a backpointer to
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the Tavor softstate.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The tavor_agent_handler_arg_t structure is used in the Tavor IB Management
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Agent routines to pass request information through the task queue. Each
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * time a request is received (by the Tavor agent request callback), one
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * of these structures is allocated and filled with the relevant information
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * for the request. It is then dispatched to the task queue (with a pointer
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * to the structure passed as an argument). From there it is later pulled
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * apart and the individual fields of the structure used to handle the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorint tavor_agent_handlers_init(tavor_state_t *state);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorint tavor_agent_handlers_fini(tavor_state_t *state);
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#endif /* _SYS_IB_ADAPTERS_TAVOR_AGENTS_H */