1/* 2 * ACPI PCI Hot Plug Controller Driver 3 * 4 * Copyright (C) 1995,2001 Compaq Computer Corporation 5 * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com) 6 * Copyright (C) 2001 IBM Corp. 7 * Copyright (C) 2002 Hiroshi Aono (h-aono@ap.jp.nec.com) 8 * Copyright (C) 2002,2003 Takayoshi Kochi (t-kochi@bq.jp.nec.com) 9 * Copyright (C) 2002,2003 NEC Corporation 10 * Copyright (C) 2003-2005 Matthew Wilcox (matthew.wilcox@hp.com) 11 * Copyright (C) 2003-2005 Hewlett Packard 12 * 13 * All rights reserved. 14 * 15 * This program is free software; you can redistribute it and/or modify 16 * it under the terms of the GNU General Public License as published by 17 * the Free Software Foundation; either version 2 of the License, or (at 18 * your option) any later version. 19 * 20 * This program is distributed in the hope that it will be useful, but 21 * WITHOUT ANY WARRANTY; without even the implied warranty of 22 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or 23 * NON INFRINGEMENT. See the GNU General Public License for more 24 * details. 25 * 26 * You should have received a copy of the GNU General Public License 27 * along with this program; if not, write to the Free Software 28 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 29 * 30 * Send feedback to <gregkh@us.ibm.com>, 31 * <t-kochi@bq.jp.nec.com> 32 * 33 */ 34 35#ifndef _ACPIPHP_H 36#define _ACPIPHP_H 37 38#include <linux/acpi.h> 39#include <linux/kobject.h> 40#include <linux/mutex.h> 41#include <linux/pci_hotplug.h> 42 43#define dbg(format, arg...) \ 44 do { \ 45 if (acpiphp_debug) \ 46 printk(KERN_DEBUG "%s: " format, \ 47 MY_NAME , ## arg); \ 48 } while (0) 49#define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg) 50#define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg) 51#define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg) 52 53struct acpiphp_bridge; 54struct acpiphp_slot; 55 56/* 57 * struct slot - slot information for each *physical* slot 58 */ 59struct slot { 60 struct hotplug_slot *hotplug_slot; 61 struct acpiphp_slot *acpi_slot; 62 struct hotplug_slot_info info; 63}; 64 65static inline const char *slot_name(struct slot *slot) 66{ 67 return hotplug_slot_name(slot->hotplug_slot); 68} 69 70/* 71 * struct acpiphp_bridge - PCI bridge information 72 * 73 * for each bridge device in ACPI namespace 74 */ 75struct acpiphp_bridge { 76 struct list_head list; 77 acpi_handle handle; 78 struct acpiphp_slot *slots; 79 80 /* Ejectable PCI-to-PCI bridge (PCI bridge and PCI function) */ 81 struct acpiphp_func *func; 82 83 int type; 84 int nr_slots; 85 86 u32 flags; 87 88 /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */ 89 struct pci_bus *pci_bus; 90 91 /* PCI-to-PCI bridge device */ 92 struct pci_dev *pci_dev; 93 94 spinlock_t res_lock; 95}; 96 97 98/* 99 * struct acpiphp_slot - PCI slot information 100 * 101 * PCI slot information for each *physical* PCI slot 102 */ 103struct acpiphp_slot { 104 struct acpiphp_slot *next; 105 struct acpiphp_bridge *bridge; /* parent */ 106 struct list_head funcs; /* one slot may have different 107 objects (i.e. for each function) */ 108 struct slot *slot; 109 struct mutex crit_sect; 110 111 u8 device; /* pci device# */ 112 113 unsigned long long sun; /* ACPI _SUN (slot unique number) */ 114 u32 flags; /* see below */ 115}; 116 117 118/* 119 * struct acpiphp_func - PCI function information 120 * 121 * PCI function information for each object in ACPI namespace 122 * typically 8 objects per slot (i.e. for each PCI function) 123 */ 124struct acpiphp_func { 125 struct acpiphp_slot *slot; /* parent */ 126 struct acpiphp_bridge *bridge; /* Ejectable PCI-to-PCI bridge */ 127 128 struct list_head sibling; 129 struct notifier_block nb; 130 acpi_handle handle; 131 132 u8 function; /* pci function# */ 133 u32 flags; /* see below */ 134}; 135 136/* 137 * struct acpiphp_attention_info - device specific attention registration 138 * 139 * ACPI has no generic method of setting/getting attention status 140 * this allows for device specific driver registration 141 */ 142struct acpiphp_attention_info 143{ 144 int (*set_attn)(struct hotplug_slot *slot, u8 status); 145 int (*get_attn)(struct hotplug_slot *slot, u8 *status); 146 struct module *owner; 147}; 148 149/* PCI bus bridge HID */ 150#define ACPI_PCI_HOST_HID "PNP0A03" 151 152/* PCI BRIDGE type */ 153#define BRIDGE_TYPE_HOST 0 154#define BRIDGE_TYPE_P2P 1 155 156/* ACPI _STA method value (ignore bit 4; battery present) */ 157#define ACPI_STA_PRESENT (0x00000001) 158#define ACPI_STA_ENABLED (0x00000002) 159#define ACPI_STA_SHOW_IN_UI (0x00000004) 160#define ACPI_STA_FUNCTIONING (0x00000008) 161#define ACPI_STA_ALL (0x0000000f) 162 163/* bridge flags */ 164#define BRIDGE_HAS_STA (0x00000001) 165#define BRIDGE_HAS_EJ0 (0x00000002) 166#define BRIDGE_HAS_HPP (0x00000004) 167#define BRIDGE_HAS_PS0 (0x00000010) 168#define BRIDGE_HAS_PS1 (0x00000020) 169#define BRIDGE_HAS_PS2 (0x00000040) 170#define BRIDGE_HAS_PS3 (0x00000080) 171 172/* slot flags */ 173 174#define SLOT_POWEREDON (0x00000001) 175#define SLOT_ENABLED (0x00000002) 176#define SLOT_MULTIFUNCTION (0x00000004) 177 178/* function flags */ 179 180#define FUNC_HAS_STA (0x00000001) 181#define FUNC_HAS_EJ0 (0x00000002) 182#define FUNC_HAS_PS0 (0x00000010) 183#define FUNC_HAS_PS1 (0x00000020) 184#define FUNC_HAS_PS2 (0x00000040) 185#define FUNC_HAS_PS3 (0x00000080) 186#define FUNC_HAS_DCK (0x00000100) 187 188/* function prototypes */ 189 190/* acpiphp_core.c */ 191extern int acpiphp_register_attention(struct acpiphp_attention_info*info); 192extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info); 193extern int acpiphp_register_hotplug_slot(struct acpiphp_slot *slot); 194extern void acpiphp_unregister_hotplug_slot(struct acpiphp_slot *slot); 195 196/* acpiphp_glue.c */ 197extern int acpiphp_glue_init (void); 198extern void acpiphp_glue_exit (void); 199extern int acpiphp_get_num_slots (void); 200typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data); 201 202extern int acpiphp_enable_slot (struct acpiphp_slot *slot); 203extern int acpiphp_disable_slot (struct acpiphp_slot *slot); 204extern int acpiphp_eject_slot (struct acpiphp_slot *slot); 205extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot); 206extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot); 207extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot); 208extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot); 209 210/* variables */ 211extern int acpiphp_debug; 212 213#endif /* _ACPIPHP_H */ 214