xref: /openbmc/linux/drivers/crypto/ccp/sp-dev.h (revision cd238eff)
1 /*
2  * AMD Secure Processor driver
3  *
4  * Copyright (C) 2017-2018 Advanced Micro Devices, Inc.
5  *
6  * Author: Tom Lendacky <thomas.lendacky@amd.com>
7  * Author: Gary R Hook <gary.hook@amd.com>
8  * Author: Brijesh Singh <brijesh.singh@amd.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14 
15 #ifndef __SP_DEV_H__
16 #define __SP_DEV_H__
17 
18 #include <linux/device.h>
19 #include <linux/pci.h>
20 #include <linux/spinlock.h>
21 #include <linux/mutex.h>
22 #include <linux/list.h>
23 #include <linux/wait.h>
24 #include <linux/dmapool.h>
25 #include <linux/hw_random.h>
26 #include <linux/bitops.h>
27 #include <linux/interrupt.h>
28 #include <linux/irqreturn.h>
29 
30 #define SP_MAX_NAME_LEN		32
31 
32 #define CACHE_NONE			0x00
33 #define CACHE_WB_NO_ALLOC		0xb7
34 
35 /* Structure to hold CCP device data */
36 struct ccp_device;
37 struct ccp_vdata {
38 	const unsigned int version;
39 	const unsigned int dma_chan_attr;
40 	void (*setup)(struct ccp_device *);
41 	const struct ccp_actions *perform;
42 	const unsigned int offset;
43 	const unsigned int rsamax;
44 };
45 
46 struct psp_vdata {
47 	const unsigned int cmdresp_reg;
48 	const unsigned int cmdbuff_addr_lo_reg;
49 	const unsigned int cmdbuff_addr_hi_reg;
50 	const unsigned int feature_reg;
51 	const unsigned int inten_reg;
52 	const unsigned int intsts_reg;
53 };
54 
55 /* Structure to hold SP device data */
56 struct sp_dev_vdata {
57 	const unsigned int bar;
58 
59 	const struct ccp_vdata *ccp_vdata;
60 	const struct psp_vdata *psp_vdata;
61 };
62 
63 struct sp_device {
64 	struct list_head entry;
65 
66 	struct device *dev;
67 
68 	struct sp_dev_vdata *dev_vdata;
69 	unsigned int ord;
70 	char name[SP_MAX_NAME_LEN];
71 
72 	/* Bus specific device information */
73 	void *dev_specific;
74 
75 	/* I/O area used for device communication. */
76 	void __iomem *io_map;
77 
78 	/* DMA caching attribute support */
79 	unsigned int axcache;
80 
81 	/* get and set master device */
82 	struct sp_device*(*get_psp_master_device)(void);
83 	void (*set_psp_master_device)(struct sp_device *);
84 
85 	bool irq_registered;
86 	bool use_tasklet;
87 
88 	unsigned int ccp_irq;
89 	irq_handler_t ccp_irq_handler;
90 	void *ccp_irq_data;
91 
92 	unsigned int psp_irq;
93 	irq_handler_t psp_irq_handler;
94 	void *psp_irq_data;
95 
96 	void *ccp_data;
97 	void *psp_data;
98 };
99 
100 int sp_pci_init(void);
101 void sp_pci_exit(void);
102 
103 int sp_platform_init(void);
104 void sp_platform_exit(void);
105 
106 struct sp_device *sp_alloc_struct(struct device *dev);
107 
108 int sp_init(struct sp_device *sp);
109 void sp_destroy(struct sp_device *sp);
110 struct sp_device *sp_get_master(void);
111 
112 int sp_suspend(struct sp_device *sp, pm_message_t state);
113 int sp_resume(struct sp_device *sp);
114 int sp_request_ccp_irq(struct sp_device *sp, irq_handler_t handler,
115 		       const char *name, void *data);
116 void sp_free_ccp_irq(struct sp_device *sp, void *data);
117 int sp_request_psp_irq(struct sp_device *sp, irq_handler_t handler,
118 		       const char *name, void *data);
119 void sp_free_psp_irq(struct sp_device *sp, void *data);
120 struct sp_device *sp_get_psp_master_device(void);
121 
122 #ifdef CONFIG_CRYPTO_DEV_SP_CCP
123 
124 int ccp_dev_init(struct sp_device *sp);
125 void ccp_dev_destroy(struct sp_device *sp);
126 
127 int ccp_dev_suspend(struct sp_device *sp, pm_message_t state);
128 int ccp_dev_resume(struct sp_device *sp);
129 
130 #else	/* !CONFIG_CRYPTO_DEV_SP_CCP */
131 
132 static inline int ccp_dev_init(struct sp_device *sp)
133 {
134 	return 0;
135 }
136 static inline void ccp_dev_destroy(struct sp_device *sp) { }
137 
138 static inline int ccp_dev_suspend(struct sp_device *sp, pm_message_t state)
139 {
140 	return 0;
141 }
142 static inline int ccp_dev_resume(struct sp_device *sp)
143 {
144 	return 0;
145 }
146 #endif	/* CONFIG_CRYPTO_DEV_SP_CCP */
147 
148 #ifdef CONFIG_CRYPTO_DEV_SP_PSP
149 
150 int psp_dev_init(struct sp_device *sp);
151 void psp_pci_init(void);
152 void psp_dev_destroy(struct sp_device *sp);
153 void psp_pci_exit(void);
154 
155 #else /* !CONFIG_CRYPTO_DEV_SP_PSP */
156 
157 static inline int psp_dev_init(struct sp_device *sp) { return 0; }
158 static inline void psp_pci_init(void) { }
159 static inline void psp_dev_destroy(struct sp_device *sp) { }
160 static inline void psp_pci_exit(void) { }
161 
162 #endif /* CONFIG_CRYPTO_DEV_SP_PSP */
163 
164 #endif
165