mei: me: change power gating function name conventions
[muen/linux.git] / drivers / misc / mei / hw-me.h
1 /*
2  *
3  * Intel Management Engine Interface (Intel MEI) Linux driver
4  * Copyright (c) 2003-2012, Intel Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms and conditions of the GNU General Public License,
8  * version 2, as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13  * more details.
14  *
15  */
16
17
18
19 #ifndef _MEI_INTERFACE_H_
20 #define _MEI_INTERFACE_H_
21
22 #include <linux/irqreturn.h>
23 #include <linux/pci.h>
24 #include <linux/mei.h>
25
26 #include "mei_dev.h"
27 #include "client.h"
28
29 /*
30  * mei_cfg - mei device configuration
31  *
32  * @fw_status: FW status
33  * @quirk_probe: device exclusion quirk
34  */
35 struct mei_cfg {
36         const struct mei_fw_status fw_status;
37         bool (*quirk_probe)(struct pci_dev *pdev);
38 };
39
40
41 #define MEI_PCI_DEVICE(dev, cfg) \
42         .vendor = PCI_VENDOR_ID_INTEL, .device = (dev), \
43         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, \
44         .driver_data = (kernel_ulong_t)&(cfg)
45
46
47 #define MEI_ME_RPM_TIMEOUT    500 /* ms */
48
49 /**
50  * struct mei_me_hw - me hw specific data
51  *
52  * @cfg: per device generation config and ops
53  * @mem_addr:  io memory address
54  * @pg_state:      power gating state
55  */
56 struct mei_me_hw {
57         const struct mei_cfg *cfg;
58         void __iomem *mem_addr;
59         enum mei_pg_state pg_state;
60 };
61
62 #define to_me_hw(dev) (struct mei_me_hw *)((dev)->hw)
63
64 extern const struct mei_cfg mei_me_legacy_cfg;
65 extern const struct mei_cfg mei_me_ich_cfg;
66 extern const struct mei_cfg mei_me_pch_cfg;
67 extern const struct mei_cfg mei_me_pch_cpt_pbg_cfg;
68 extern const struct mei_cfg mei_me_pch8_cfg;
69 extern const struct mei_cfg mei_me_pch8_sps_cfg;
70
71 struct mei_device *mei_me_dev_init(struct pci_dev *pdev,
72                                    const struct mei_cfg *cfg);
73
74 int mei_me_pg_enter_sync(struct mei_device *dev);
75 int mei_me_pg_exit_sync(struct mei_device *dev);
76
77 irqreturn_t mei_me_irq_quick_handler(int irq, void *dev_id);
78 irqreturn_t mei_me_irq_thread_handler(int irq, void *dev_id);
79
80 #endif /* _MEI_INTERFACE_H_ */