hpci_socket_info_t(D4hpci)

hpci_socket_info_t -- hotplug socket information structure

Syntax

   #include <sys/types.h>
   #include <sys/hpci.h>
   #include <sys/ddi.h>

Description

The hpci_socket_info_t structure is the main data structure used by the hotplug controller driver, the hot plug controller interface, and the user application to get and set information about a hotplug-capable socket.

Structure definition

The hpci_socket_info_t structure contains the following members:

   char                    label[HPCI_MAX_SOCKET_LABEL_LEN];
   uchar_t                 bustype;
   uint_t                  mask;
   uint_t                  ROmask;
   uint_t                  current_state;
   uint_t                  prev_state;
   int                     busid;
   int                     hpcid;
   
   union {
   	hpci_pci_socket_t      pci_data;
   	char                   maxSocket[48];
   } hpci_socket_udata;
   ushort_t                function_cnt;
   hpci_function_info_t    *function;

The hpci_pci_socket_t structure contains the following members:

   ushort_t                 card_speed;
   uchar_t                  mem_type;
   ushort_t                 slotnum;

Structure members

The members of the hpci_socket_info_t structure are defined as:

label

Null terminated socket label assigned by the HPCD driver.

bustype

Bus type; must be set to CM_BUS_PCI for HPCI version 1.

mask

Valid bits for this socket; assigned by the HPCD driver. Valid flags are:

HPCI_SOCKET_EMPTY: indicates the presence of a card in the socket
HPCI_SOCKET_POWER_ON: socket is powered on or off
HPCI_SOCKET_GENERAL_FAULT: a general fault was detected on this socket
HPCI_SOCKET_PCI_PRSNT_PIN1: presence pin 1 is detected
HPCI_SOCKET_PCI_PRSNT_PIN2: presence pin 2 is detected
HPCI_SOCKET_PCI_POWER_FAULT: a power fault condition was detected on this socket
HPCI_SOCKET_PCI_ATTENTION_STATE: attention LED is on/off
HPCI_SOCKET_PCI_HOTPLUG_CAPABLE: socket is hot-plug capable
HPCI_SOCKET_PCI_CONFIG_FAULT: failure to configure the PCI config space
HPCI_SOCKET_PCI_BAD_FREQUENCY: frequency mismatch
HPCI_SOCKET_PCI_INTER_LOCKED: interlock supported/unsupported

current_state

Current state of the socket.

ROmask

Read-only bits in the mask that can only be set by HPCD.

prev_state

State of the socket prior to the last change.

busid

Bus identifier assigned by HPCD.

pci_data

PCI specific information

maxsocket

Placeholder for future expansion.

function_cnt

Total number of functions; assigned by the HPCD driver.

function

Linked list of functions; assigned by the HPCD driver.

The members of the hpci_pci_socket_t structure are defined as:

card_speed: Speed of this card, expressed in Mhz. For example, 33 indicates 33 Mhz and 66 indicates Mhz.
mem_type: Set to either HPCI_MEM_32BITS or HPCI_MEM_64BITS to indicate the type of memory supported by this device.
slotnum: PCI slot number assigned by the HPCD driver.

Usage

The relationship between the current_state, mask, and ROmask members:

mask indicates which bits are valid for this socket. For example:
```
   HPCI_SOCKET_EMPTY | HPCI_SOCKET_PCI_ATTENTION_STATE | HPCI_SOCKET_POWER_ON
```
This indicates that the bits mentioned above are valid for this socket.
ROmask would be set to HPCI_SOCKET_EMPTY to indicate that it is a read-only bit and cannot be changed by software.
current_state: If HPCI_SOCKET_EMPTY and HPCI_SOCKET_PCI_ATTENTION_STATE are cleared, and HPCI_SOCKET_POWER_ON is set, it means that the socket is not empty, the attention LED is off, and socket power is on.

Hardware applicability

All

Version applicability

hpci: 1

References

``Hotplug devices'' in HDK Technical Reference
``PCI'' in HDK Technical Reference