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> /* for KOBJ_NAME_LEN */ 40 #include "pci_hotplug.h" 41 42 #define dbg(format, arg...) \ 43 do { \ 44 if (acpiphp_debug) \ 45 printk(KERN_DEBUG "%s: " format, \ 46 MY_NAME , ## arg); \ 47 } while (0) 48 #define err(format, arg...) printk(KERN_ERR "%s: " format, MY_NAME , ## arg) 49 #define info(format, arg...) printk(KERN_INFO "%s: " format, MY_NAME , ## arg) 50 #define warn(format, arg...) printk(KERN_WARNING "%s: " format, MY_NAME , ## arg) 51 52 /* name size which is used for entries in pcihpfs */ 53 #define SLOT_NAME_SIZE KOBJ_NAME_LEN /* {_SUN} */ 54 55 struct acpiphp_bridge; 56 struct acpiphp_slot; 57 58 /* 59 * struct slot - slot information for each *physical* slot 60 */ 61 struct slot { 62 u8 number; 63 struct hotplug_slot *hotplug_slot; 64 struct list_head slot_list; 65 66 struct acpiphp_slot *acpi_slot; 67 }; 68 69 /** 70 * struct hpp_param - ACPI 2.0 _HPP Hot Plug Parameters 71 * @cache_line_size in DWORD 72 * @latency_timer in PCI clock 73 * @enable_SERR 0 or 1 74 * @enable_PERR 0 or 1 75 */ 76 struct hpp_param { 77 u8 cache_line_size; 78 u8 latency_timer; 79 u8 enable_SERR; 80 u8 enable_PERR; 81 }; 82 83 84 /** 85 * struct acpiphp_bridge - PCI bridge information 86 * 87 * for each bridge device in ACPI namespace 88 */ 89 struct acpiphp_bridge { 90 struct list_head list; 91 acpi_handle handle; 92 struct acpiphp_slot *slots; 93 int type; 94 int nr_slots; 95 96 u32 flags; 97 98 /* This bus (host bridge) or Secondary bus (PCI-to-PCI bridge) */ 99 struct pci_bus *pci_bus; 100 101 /* PCI-to-PCI bridge device */ 102 struct pci_dev *pci_dev; 103 104 /* ACPI 2.0 _HPP parameters */ 105 struct hpp_param hpp; 106 107 spinlock_t res_lock; 108 }; 109 110 111 /** 112 * struct acpiphp_slot - PCI slot information 113 * 114 * PCI slot information for each *physical* PCI slot 115 */ 116 struct acpiphp_slot { 117 struct acpiphp_slot *next; 118 struct acpiphp_bridge *bridge; /* parent */ 119 struct list_head funcs; /* one slot may have different 120 objects (i.e. for each function) */ 121 struct semaphore crit_sect; 122 123 u32 id; /* slot id (serial #) for hotplug core */ 124 u8 device; /* pci device# */ 125 126 u32 sun; /* ACPI _SUN (slot unique number) */ 127 u32 slotno; /* slot number relative to bridge */ 128 u32 flags; /* see below */ 129 }; 130 131 132 /** 133 * struct acpiphp_func - PCI function information 134 * 135 * PCI function information for each object in ACPI namespace 136 * typically 8 objects per slot (i.e. for each PCI function) 137 */ 138 struct acpiphp_func { 139 struct acpiphp_slot *slot; /* parent */ 140 141 struct list_head sibling; 142 struct pci_dev *pci_dev; 143 144 acpi_handle handle; 145 146 u8 function; /* pci function# */ 147 u32 flags; /* see below */ 148 }; 149 150 /** 151 * struct acpiphp_attention_info - device specific attention registration 152 * 153 * ACPI has no generic method of setting/getting attention status 154 * this allows for device specific driver registration 155 */ 156 struct acpiphp_attention_info 157 { 158 int (*set_attn)(struct hotplug_slot *slot, u8 status); 159 int (*get_attn)(struct hotplug_slot *slot, u8 *status); 160 struct module *owner; 161 }; 162 163 /* PCI bus bridge HID */ 164 #define ACPI_PCI_HOST_HID "PNP0A03" 165 166 /* PCI BRIDGE type */ 167 #define BRIDGE_TYPE_HOST 0 168 #define BRIDGE_TYPE_P2P 1 169 170 /* ACPI _STA method value (ignore bit 4; battery present) */ 171 #define ACPI_STA_PRESENT (0x00000001) 172 #define ACPI_STA_ENABLED (0x00000002) 173 #define ACPI_STA_SHOW_IN_UI (0x00000004) 174 #define ACPI_STA_FUNCTIONING (0x00000008) 175 #define ACPI_STA_ALL (0x0000000f) 176 177 /* bridge flags */ 178 #define BRIDGE_HAS_STA (0x00000001) 179 #define BRIDGE_HAS_EJ0 (0x00000002) 180 #define BRIDGE_HAS_HPP (0x00000004) 181 #define BRIDGE_HAS_PS0 (0x00000010) 182 #define BRIDGE_HAS_PS1 (0x00000020) 183 #define BRIDGE_HAS_PS2 (0x00000040) 184 #define BRIDGE_HAS_PS3 (0x00000080) 185 186 /* slot flags */ 187 188 #define SLOT_POWEREDON (0x00000001) 189 #define SLOT_ENABLED (0x00000002) 190 #define SLOT_MULTIFUNCTION (0x00000004) 191 192 /* function flags */ 193 194 #define FUNC_HAS_STA (0x00000001) 195 #define FUNC_HAS_EJ0 (0x00000002) 196 #define FUNC_HAS_PS0 (0x00000010) 197 #define FUNC_HAS_PS1 (0x00000020) 198 #define FUNC_HAS_PS2 (0x00000040) 199 #define FUNC_HAS_PS3 (0x00000080) 200 201 /* function prototypes */ 202 203 /* acpiphp_core.c */ 204 extern int acpiphp_register_attention(struct acpiphp_attention_info*info); 205 extern int acpiphp_unregister_attention(struct acpiphp_attention_info *info); 206 207 /* acpiphp_glue.c */ 208 extern int acpiphp_glue_init (void); 209 extern void acpiphp_glue_exit (void); 210 extern int acpiphp_get_num_slots (void); 211 extern struct acpiphp_slot *get_slot_from_id (int id); 212 typedef int (*acpiphp_callback)(struct acpiphp_slot *slot, void *data); 213 214 extern int acpiphp_enable_slot (struct acpiphp_slot *slot); 215 extern int acpiphp_disable_slot (struct acpiphp_slot *slot); 216 extern u8 acpiphp_get_power_status (struct acpiphp_slot *slot); 217 extern u8 acpiphp_get_attention_status (struct acpiphp_slot *slot); 218 extern u8 acpiphp_get_latch_status (struct acpiphp_slot *slot); 219 extern u8 acpiphp_get_adapter_status (struct acpiphp_slot *slot); 220 extern u32 acpiphp_get_address (struct acpiphp_slot *slot); 221 222 /* variables */ 223 extern int acpiphp_debug; 224 225 #endif /* _ACPIPHP_H */ 226