Merge branch 'for-5.4/ish' into for-linus
[sfrench/cifs-2.6.git] / drivers / hid / intel-ish-hid / ipc / hw-ish.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * H/W layer of ISHTP provider device (ISH)
4  *
5  * Copyright (c) 2014-2016, Intel Corporation.
6  */
7
8 #ifndef _ISHTP_HW_ISH_H_
9 #define _ISHTP_HW_ISH_H_
10
11 #include <linux/pci.h>
12 #include <linux/interrupt.h>
13 #include "hw-ish-regs.h"
14 #include "ishtp-dev.h"
15
16 #define CHV_DEVICE_ID           0x22D8
17 #define BXT_Ax_DEVICE_ID        0x0AA2
18 #define BXT_Bx_DEVICE_ID        0x1AA2
19 #define APL_Ax_DEVICE_ID        0x5AA2
20 #define SPT_Ax_DEVICE_ID        0x9D35
21 #define CNL_Ax_DEVICE_ID        0x9DFC
22 #define GLK_Ax_DEVICE_ID        0x31A2
23 #define CNL_H_DEVICE_ID         0xA37C
24 #define ICL_MOBILE_DEVICE_ID    0x34FC
25 #define SPT_H_DEVICE_ID         0xA135
26 #define CML_LP_DEVICE_ID        0x02FC
27 #define EHL_Ax_DEVICE_ID        0x4BB3
28
29 #define REVISION_ID_CHT_A0      0x6
30 #define REVISION_ID_CHT_Ax_SI   0x0
31 #define REVISION_ID_CHT_Bx_SI   0x10
32 #define REVISION_ID_CHT_Kx_SI   0x20
33 #define REVISION_ID_CHT_Dx_SI   0x30
34 #define REVISION_ID_CHT_B0      0xB0
35 #define REVISION_ID_SI_MASK     0x70
36
37 struct ipc_rst_payload_type {
38         uint16_t        reset_id;
39         uint16_t        reserved;
40 };
41
42 struct time_sync_format {
43         uint8_t ts1_source;
44         uint8_t ts2_source;
45         uint16_t reserved;
46 } __packed;
47
48 struct ipc_time_update_msg {
49         uint64_t primary_host_time;
50         struct time_sync_format sync_info;
51         uint64_t secondary_host_time;
52 } __packed;
53
54 enum {
55         HOST_UTC_TIME_USEC = 0,
56         HOST_SYSTEM_TIME_USEC = 1
57 };
58
59 struct ish_hw {
60         void __iomem *mem_addr;
61 };
62
63 /*
64  * ISH FW status type
65  */
66 enum {
67         FWSTS_AFTER_RESET               = 0,
68         FWSTS_WAIT_FOR_HOST             = 4,
69         FWSTS_START_KERNEL_DMA          = 5,
70         FWSTS_FW_IS_RUNNING             = 7,
71         FWSTS_SENSOR_APP_LOADED         = 8,
72         FWSTS_SENSOR_APP_RUNNING        = 15
73 };
74
75 #define to_ish_hw(dev) (struct ish_hw *)((dev)->hw)
76
77 irqreturn_t ish_irq_handler(int irq, void *dev_id);
78 struct ishtp_device *ish_dev_init(struct pci_dev *pdev);
79 int ish_hw_start(struct ishtp_device *dev);
80 void ish_device_disable(struct ishtp_device *dev);
81 int ish_disable_dma(struct ishtp_device *dev);
82
83 #endif /* _ISHTP_HW_ISH_H_ */