03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER START
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The contents of this file are subject to the terms of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Common Development and Distribution License (the "License").
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You may not use this file except in compliance with the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
03831d35f7499c87d51205817c93e9a8d42c4baestevel * or http://www.opensolaris.org/os/licensing.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * See the License for the specific language governing permissions
03831d35f7499c87d51205817c93e9a8d42c4baestevel * and limitations under the License.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * When distributing Covered Code, include this CDDL HEADER in each
03831d35f7499c87d51205817c93e9a8d42c4baestevel * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * If applicable, add the following below this CDDL HEADER, with the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * fields enclosed by brackets "[]" replaced with your own identifying
03831d35f7499c87d51205817c93e9a8d42c4baestevel * information: Portions Copyright [yyyy] [name of copyright owner]
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL HEADER END
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Copyright 2005 Sun Microsystems, Inc. All rights reserved.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Use is subject to license terms.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifndef _SYS_SCHPC_H
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define _SYS_SCHPC_H
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#pragma ident "%Z%%M% %I% %E% SMI"
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __cplusplus
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" {
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define STARCAT_MAX_SLOTS (18 * 4)
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Slot LED Descriptor
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Each hot pluggable PCI/cPCI slot has three leds. Each LED can
03831d35f7499c87d51205817c93e9a8d42c4baestevel * be on, off, or flashing.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef struct slot_led {
03831d35f7499c87d51205817c93e9a8d42c4baestevel char led_power;
03831d35f7499c87d51205817c93e9a8d42c4baestevel char led_service;
03831d35f7499c87d51205817c93e9a8d42c4baestevel char led_fault;
03831d35f7499c87d51205817c93e9a8d42c4baestevel char reserved;
03831d35f7499c87d51205817c93e9a8d42c4baestevel} slot_led_t;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define LED_OFF 0x00
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define LED_ON 0x01
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define LED_FLASH 0x02
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * LED Commands
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define POWER_LED_ON 0x00000001
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define POWER_LED_OFF 0x00000002
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define POWER_LED_FLASH 0x00000004
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SERVICE_LED_ON 0x00000010
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SERVICE_LED_OFF 0x00000020
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SERVICE_LED_FLASH 0x00000040
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define FAULT_LED_ON 0x00000100
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define FAULT_LED_OFF 0x00000200
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define FAULT_LED_FLASH 0x00000400
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Hot Plug Slot Descriptor. Each hot pluggable slot will have
03831d35f7499c87d51205817c93e9a8d42c4baestevel * a schpc_slot_t structure allocated for it.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef struct {
03831d35f7499c87d51205817c93e9a8d42c4baestevel dev_info_t *devi; /* Ptr to PCI dev_info */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint32_t state; /* Slot's Hot Plug State */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint16_t pci_id; /* PCI ID for slot */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint8_t expander; /* Centerplane Expander */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint8_t board; /* Number of IO Board 0/1 */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint8_t schizo; /* Number of Schizo 0/1 */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint8_t leaf; /* A or B (0 or 1) */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint8_t slot; /* Slot Number */
03831d35f7499c87d51205817c93e9a8d42c4baestevel slot_led_t led; /* Current LED state */
03831d35f7499c87d51205817c93e9a8d42c4baestevel hpc_slot_ops_t *slot_ops; /* Ptr HPC entry points */
03831d35f7499c87d51205817c93e9a8d42c4baestevel hpc_slot_info_t slot_info; /* Bus Specific SlotInfo */
03831d35f7499c87d51205817c93e9a8d42c4baestevel hpc_slot_t slot_handle; /* Handle used by HPS */
03831d35f7499c87d51205817c93e9a8d42c4baestevel char nexus_path[MAXNAMELEN]; /* Pathname of Nexus */
03831d35f7499c87d51205817c93e9a8d42c4baestevel char ap_id[MAXNAMELEN]; /* Attachment point name */
03831d35f7499c87d51205817c93e9a8d42c4baestevel caddr_t saved_regs_va[3]; /* Reg set virtual addresses */
03831d35f7499c87d51205817c93e9a8d42c4baestevel ddi_acc_handle_t saved_handle[3]; /* Handle from map in */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint64_t *saved_regs; /* Ptr to saved off regs */
03831d35f7499c87d51205817c93e9a8d42c4baestevel int saved_size; /* Size of saved off regs */
03831d35f7499c87d51205817c93e9a8d42c4baestevel} schpc_slot_t;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * PCI/cPCI Hot Plug states for an attachment point
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_REC_GOOD 0x01 /* Receptacle is Good */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_OCC_GOOD 0x02 /* Occupant is Good */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_BAD_NEXUS 0x04 /* Invalid PCI Nexus */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_PRESENT 0x10 /* Occupant Present */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_CONNECTED 0x100 /* Receptacle Connected */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_CONFIGURED 0x1000 /* Occupant Configured */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_AUTOCFG_ENABLE 0x10000 /* Auto Configuration Enabled */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_ENUM 0x100000 /* ENUM Handling in progress */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_EXECUTING 0x200000 /* Executing a mailbox cmd */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOTSTATE_HPCINITED 0x400000 /* Ready to accept commands */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Soft state structure definition for each schpc instance.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * There will be a single soft state stucture for each IO Board.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef struct schpc {
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint32_t schpc_instance; /* Instance # */
03831d35f7499c87d51205817c93e9a8d42c4baestevel dev_info_t *schpc_devi; /* Ptr to dev_info */
03831d35f7499c87d51205817c93e9a8d42c4baestevel kmutex_t schpc_mutex; /* Mutex to protect struct */
03831d35f7499c87d51205817c93e9a8d42c4baestevel kcondvar_t schpc_cv; /* Conditional Variable */
03831d35f7499c87d51205817c93e9a8d42c4baestevel char *schpc_property; /* Ptr to slot-table */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint32_t schpc_property_size; /* Size of slot-table */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint32_t schpc_hotplugmodel; /* Type of Hot Plug */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint16_t schpc_transid; /* Current transaction ID */
03831d35f7499c87d51205817c93e9a8d42c4baestevel uint16_t schpc_number_of_slots; /* Slot on IO Board */
03831d35f7499c87d51205817c93e9a8d42c4baestevel struct schpc *schpc_next; /* Ptr to next schpc */
03831d35f7499c87d51205817c93e9a8d42c4baestevel schpc_slot_t *schpc_slot; /* Slot Specific stuff */
03831d35f7499c87d51205817c93e9a8d42c4baestevel} schpc_t;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Types of Hot Plug/Hot Swap Models
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_HOTPLUGTYPE_NOTHOTPLUGGABLE 0
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_HOTPLUGTYPE_CPCIHOTPLUG 1
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_HOTPLUGTYPE_CPCIHOTSWAPBASIC 2
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_HOTPLUGTYPE_CPCIHOTSWAPFULL 3
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_HOTPLUGTYPE_PCIHOTPLUG 4
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * schpc_t's slot table, schpc_slot[], is indexed by
03831d35f7499c87d51205817c93e9a8d42c4baestevel * a value in the range [0,STARCAT_MAX_SLOTS).
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * That index is composed of these bit-fields:
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * <-- slot num -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel * |----------------------------|
03831d35f7499c87d51205817c93e9a8d42c4baestevel * | expander | schizo | leaf |
03831d35f7499c87d51205817c93e9a8d42c4baestevel * |------------|--------|------|
03831d35f7499c87d51205817c93e9a8d42c4baestevel * 7 2 1 0
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Extract various bit-fields from a slot table index: */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOT_EXPANDER(idx) (((idx) & 0xfc) >> 2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOT_SCHIZO(idx) (((idx) & 0x2) >> 1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOT_LEAF(idx) ((idx) & 0x1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_SLOT_NUM(idx) ((idx) & (0x1 | 0x2))
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Build a slot index from component bit-fields: */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_MAKE_SLOT_INDEX2(expander, slot_num)\
03831d35f7499c87d51205817c93e9a8d42c4baestevel (((expander) << 2) | (slot_num))
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_MAKE_SLOT_INDEX3(expander, schizo, leaf)\
03831d35f7499c87d51205817c93e9a8d42c4baestevel (((expander) << 2) | ((schizo) << 1) | (leaf))
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Integer values for the clock-frequency property.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_33MHZ (33 * 1000 * 1000)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_66MHZ (66 * 1000 * 1000)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_90MHZ (90 * 1000 * 1000)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define SCHPC_133MHZ (133 * 1000 * 1000)
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * module-revision# for the XMITS versions
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define XMITS_10 1
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define XMITS_20 2
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define XMITS_21 3
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define XMITS_30 4
03831d35f7499c87d51205817c93e9a8d42c4baestevel#define XMITS_31 5
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int schpc_add_pci(dev_info_t *);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern int schpc_remove_pci(dev_info_t *);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef __cplusplus
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* _SYS_SCHPC_H */