PCI/portdrv: Merge pcieport_if.h into portdrv.h
[muen/linux.git] / drivers / pci / hotplug / pciehp.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * PCI Express Hot Plug Controller Driver
4  *
5  * Copyright (C) 1995,2001 Compaq Computer Corporation
6  * Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
7  * Copyright (C) 2001 IBM Corp.
8  * Copyright (C) 2003-2004 Intel Corporation
9  *
10  * All rights reserved.
11  *
12  * Send feedback to <greg@kroah.com>, <kristen.c.accardi@intel.com>
13  *
14  */
15 #ifndef _PCIEHP_H
16 #define _PCIEHP_H
17
18 #include <linux/types.h>
19 #include <linux/pci.h>
20 #include <linux/pci_hotplug.h>
21 #include <linux/delay.h>
22 #include <linux/sched/signal.h>         /* signal_pending() */
23 #include <linux/mutex.h>
24 #include <linux/workqueue.h>
25
26 #include "../pcie/portdrv.h"
27
28 #define MY_NAME "pciehp"
29
30 extern bool pciehp_poll_mode;
31 extern int pciehp_poll_time;
32 extern bool pciehp_debug;
33
34 #define dbg(format, arg...)                                             \
35 do {                                                                    \
36         if (pciehp_debug)                                               \
37                 printk(KERN_DEBUG "%s: " format, MY_NAME, ## arg);      \
38 } while (0)
39 #define err(format, arg...)                                             \
40         printk(KERN_ERR "%s: " format, MY_NAME, ## arg)
41 #define info(format, arg...)                                            \
42         printk(KERN_INFO "%s: " format, MY_NAME, ## arg)
43 #define warn(format, arg...)                                            \
44         printk(KERN_WARNING "%s: " format, MY_NAME, ## arg)
45
46 #define ctrl_dbg(ctrl, format, arg...)                                  \
47         do {                                                            \
48                 if (pciehp_debug)                                       \
49                         dev_printk(KERN_DEBUG, &ctrl->pcie->device,     \
50                                         format, ## arg);                \
51         } while (0)
52 #define ctrl_err(ctrl, format, arg...)                                  \
53         dev_err(&ctrl->pcie->device, format, ## arg)
54 #define ctrl_info(ctrl, format, arg...)                                 \
55         dev_info(&ctrl->pcie->device, format, ## arg)
56 #define ctrl_warn(ctrl, format, arg...)                                 \
57         dev_warn(&ctrl->pcie->device, format, ## arg)
58
59 #define SLOT_NAME_SIZE 10
60 struct slot {
61         u8 state;
62         struct controller *ctrl;
63         struct hotplug_slot *hotplug_slot;
64         struct delayed_work work;       /* work for button event */
65         struct mutex lock;
66         struct mutex hotplug_lock;
67         struct workqueue_struct *wq;
68 };
69
70 struct event_info {
71         u32 event_type;
72         struct slot *p_slot;
73         struct work_struct work;
74 };
75
76 struct controller {
77         struct mutex ctrl_lock;         /* controller lock */
78         struct pcie_device *pcie;       /* PCI Express port service */
79         struct slot *slot;
80         wait_queue_head_t queue;        /* sleep & wake process */
81         u32 slot_cap;
82         u16 slot_ctrl;
83         struct timer_list poll_timer;
84         unsigned long cmd_started;      /* jiffies */
85         unsigned int cmd_busy:1;
86         unsigned int link_active_reporting:1;
87         unsigned int notification_enabled:1;
88         unsigned int power_fault_detected;
89 };
90
91 #define INT_PRESENCE_ON                 1
92 #define INT_PRESENCE_OFF                2
93 #define INT_POWER_FAULT                 3
94 #define INT_BUTTON_PRESS                4
95 #define INT_LINK_UP                     5
96 #define INT_LINK_DOWN                   6
97
98 #define STATIC_STATE                    0
99 #define BLINKINGON_STATE                1
100 #define BLINKINGOFF_STATE               2
101 #define POWERON_STATE                   3
102 #define POWEROFF_STATE                  4
103
104 #define ATTN_BUTTN(ctrl)        ((ctrl)->slot_cap & PCI_EXP_SLTCAP_ABP)
105 #define POWER_CTRL(ctrl)        ((ctrl)->slot_cap & PCI_EXP_SLTCAP_PCP)
106 #define MRL_SENS(ctrl)          ((ctrl)->slot_cap & PCI_EXP_SLTCAP_MRLSP)
107 #define ATTN_LED(ctrl)          ((ctrl)->slot_cap & PCI_EXP_SLTCAP_AIP)
108 #define PWR_LED(ctrl)           ((ctrl)->slot_cap & PCI_EXP_SLTCAP_PIP)
109 #define HP_SUPR_RM(ctrl)        ((ctrl)->slot_cap & PCI_EXP_SLTCAP_HPS)
110 #define EMI(ctrl)               ((ctrl)->slot_cap & PCI_EXP_SLTCAP_EIP)
111 #define NO_CMD_CMPL(ctrl)       ((ctrl)->slot_cap & PCI_EXP_SLTCAP_NCCS)
112 #define PSN(ctrl)               (((ctrl)->slot_cap & PCI_EXP_SLTCAP_PSN) >> 19)
113
114 int pciehp_sysfs_enable_slot(struct slot *slot);
115 int pciehp_sysfs_disable_slot(struct slot *slot);
116 void pciehp_queue_interrupt_event(struct slot *slot, u32 event_type);
117 int pciehp_configure_device(struct slot *p_slot);
118 int pciehp_unconfigure_device(struct slot *p_slot);
119 void pciehp_queue_pushbutton_work(struct work_struct *work);
120 struct controller *pcie_init(struct pcie_device *dev);
121 int pcie_init_notification(struct controller *ctrl);
122 int pciehp_enable_slot(struct slot *p_slot);
123 int pciehp_disable_slot(struct slot *p_slot);
124 void pcie_enable_notification(struct controller *ctrl);
125 int pciehp_power_on_slot(struct slot *slot);
126 void pciehp_power_off_slot(struct slot *slot);
127 void pciehp_get_power_status(struct slot *slot, u8 *status);
128 void pciehp_get_attention_status(struct slot *slot, u8 *status);
129
130 void pciehp_set_attention_status(struct slot *slot, u8 status);
131 void pciehp_get_latch_status(struct slot *slot, u8 *status);
132 void pciehp_get_adapter_status(struct slot *slot, u8 *status);
133 int pciehp_query_power_fault(struct slot *slot);
134 void pciehp_green_led_on(struct slot *slot);
135 void pciehp_green_led_off(struct slot *slot);
136 void pciehp_green_led_blink(struct slot *slot);
137 int pciehp_check_link_status(struct controller *ctrl);
138 bool pciehp_check_link_active(struct controller *ctrl);
139 void pciehp_release_ctrl(struct controller *ctrl);
140 int pciehp_reset_slot(struct slot *slot, int probe);
141
142 int pciehp_set_raw_indicator_status(struct hotplug_slot *h_slot, u8 status);
143 int pciehp_get_raw_indicator_status(struct hotplug_slot *h_slot, u8 *status);
144
145 static inline const char *slot_name(struct slot *slot)
146 {
147         return hotplug_slot_name(slot->hotplug_slot);
148 }
149
150 #endif                          /* _PCIEHP_H */