xref: /openbmc/linux/drivers/crypto/caam/intern.h (revision 185c8f33)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * CAAM/SEC 4.x driver backend
4  * Private/internal definitions between modules
5  *
6  * Copyright 2008-2011 Freescale Semiconductor, Inc.
7  * Copyright 2019 NXP
8  */
9 
10 #ifndef INTERN_H
11 #define INTERN_H
12 
13 #include "ctrl.h"
14 #include <crypto/engine.h>
15 
16 /* Currently comes from Kconfig param as a ^2 (driver-required) */
17 #define JOBR_DEPTH (1 << CONFIG_CRYPTO_DEV_FSL_CAAM_RINGSIZE)
18 
19 /*
20  * Maximum size for crypto-engine software queue based on Job Ring
21  * size (JOBR_DEPTH) and a THRESHOLD (reserved for the non-crypto-API
22  * requests that are not passed through crypto-engine)
23  */
24 #define THRESHOLD 15
25 #define CRYPTO_ENGINE_MAX_QLEN (JOBR_DEPTH - THRESHOLD)
26 
27 /* Kconfig params for interrupt coalescing if selected (else zero) */
28 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_INTC
29 #define JOBR_INTC JRCFG_ICEN
30 #define JOBR_INTC_TIME_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_TIME_THLD
31 #define JOBR_INTC_COUNT_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_COUNT_THLD
32 #else
33 #define JOBR_INTC 0
34 #define JOBR_INTC_TIME_THLD 0
35 #define JOBR_INTC_COUNT_THLD 0
36 #endif
37 
38 /*
39  * Storage for tracking each in-process entry moving across a ring
40  * Each entry on an output ring needs one of these
41  */
42 struct caam_jrentry_info {
43 	void (*callbk)(struct device *dev, u32 *desc, u32 status, void *arg);
44 	void *cbkarg;	/* Argument per ring entry */
45 	u32 *desc_addr_virt;	/* Stored virt addr for postprocessing */
46 	dma_addr_t desc_addr_dma;	/* Stored bus addr for done matching */
47 	u32 desc_size;	/* Stored size for postprocessing, header derived */
48 };
49 
50 /* Private sub-storage for a single JobR */
51 struct caam_drv_private_jr {
52 	struct list_head	list_node;	/* Job Ring device list */
53 	struct device		*dev;
54 	int ridx;
55 	struct caam_job_ring __iomem *rregs;	/* JobR's register space */
56 	struct tasklet_struct irqtask;
57 	int irq;			/* One per queue */
58 	bool hwrng;
59 
60 	/* Number of scatterlist crypt transforms active on the JobR */
61 	atomic_t tfm_count ____cacheline_aligned;
62 
63 	/* Job ring info */
64 	struct caam_jrentry_info *entinfo;	/* Alloc'ed 1 per ring entry */
65 	spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
66 	u32 inpring_avail;	/* Number of free entries in input ring */
67 	int head;			/* entinfo (s/w ring) head index */
68 	void *inpring;			/* Base of input ring, alloc
69 					 * DMA-safe */
70 	int out_ring_read_index;	/* Output index "tail" */
71 	int tail;			/* entinfo (s/w ring) tail index */
72 	void *outring;			/* Base of output ring, DMA-safe */
73 	struct crypto_engine *engine;
74 };
75 
76 /*
77  * Driver-private storage for a single CAAM block instance
78  */
79 struct caam_drv_private {
80 	/* Physical-presence section */
81 	struct caam_ctrl __iomem *ctrl; /* controller region */
82 	struct caam_deco __iomem *deco; /* DECO/CCB views */
83 	struct caam_assurance __iomem *assure;
84 	struct caam_queue_if __iomem *qi; /* QI control region */
85 	struct caam_job_ring __iomem *jr[4];	/* JobR's register space */
86 
87 	struct iommu_domain *domain;
88 
89 	/*
90 	 * Detected geometry block. Filled in from device tree if powerpc,
91 	 * or from register-based version detection code
92 	 */
93 	u8 total_jobrs;		/* Total Job Rings in device */
94 	u8 qi_present;		/* Nonzero if QI present in device */
95 	u8 blob_present;	/* Nonzero if BLOB support present in device */
96 	u8 mc_en;		/* Nonzero if MC f/w is active */
97 	u8 optee_en;		/* Nonzero if OP-TEE f/w is active */
98 	bool pr_support;        /* RNG prediction resistance available */
99 	int secvio_irq;		/* Security violation interrupt number */
100 	int virt_en;		/* Virtualization enabled in CAAM */
101 	int era;		/* CAAM Era (internal HW revision) */
102 
103 #define	RNG4_MAX_HANDLES 2
104 	/* RNG4 block */
105 	u32 rng4_sh_init;	/* This bitmap shows which of the State
106 				   Handles of the RNG4 block are initialized
107 				   by this driver */
108 
109 	struct clk_bulk_data *clks;
110 	int num_clks;
111 	/*
112 	 * debugfs entries for developer view into driver/device
113 	 * variables at runtime.
114 	 */
115 #ifdef CONFIG_DEBUG_FS
116 	struct dentry *ctl; /* controller dir */
117 	struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
118 #endif
119 };
120 
121 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_CRYPTO_API
122 
123 int caam_algapi_init(struct device *dev);
124 void caam_algapi_exit(void);
125 
126 #else
127 
128 static inline int caam_algapi_init(struct device *dev)
129 {
130 	return 0;
131 }
132 
133 static inline void caam_algapi_exit(void)
134 {
135 }
136 
137 #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_CRYPTO_API */
138 
139 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_AHASH_API
140 
141 int caam_algapi_hash_init(struct device *dev);
142 void caam_algapi_hash_exit(void);
143 
144 #else
145 
146 static inline int caam_algapi_hash_init(struct device *dev)
147 {
148 	return 0;
149 }
150 
151 static inline void caam_algapi_hash_exit(void)
152 {
153 }
154 
155 #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_AHASH_API */
156 
157 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_PKC_API
158 
159 int caam_pkc_init(struct device *dev);
160 void caam_pkc_exit(void);
161 
162 #else
163 
164 static inline int caam_pkc_init(struct device *dev)
165 {
166 	return 0;
167 }
168 
169 static inline void caam_pkc_exit(void)
170 {
171 }
172 
173 #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_PKC_API */
174 
175 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_API
176 
177 int caam_rng_init(struct device *dev);
178 void caam_rng_exit(struct device *dev);
179 
180 #else
181 
182 static inline int caam_rng_init(struct device *dev)
183 {
184 	return 0;
185 }
186 
187 static inline void caam_rng_exit(struct device *dev) {}
188 
189 #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_API */
190 
191 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_PRNG_API
192 
193 int caam_prng_register(struct device *dev);
194 void caam_prng_unregister(void *data);
195 
196 #else
197 
198 static inline int caam_prng_register(struct device *dev)
199 {
200 	return 0;
201 }
202 
203 static inline void caam_prng_unregister(void *data) {}
204 #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_PRNG_API */
205 
206 #ifdef CONFIG_CAAM_QI
207 
208 int caam_qi_algapi_init(struct device *dev);
209 void caam_qi_algapi_exit(void);
210 
211 #else
212 
213 static inline int caam_qi_algapi_init(struct device *dev)
214 {
215 	return 0;
216 }
217 
218 static inline void caam_qi_algapi_exit(void)
219 {
220 }
221 
222 #endif /* CONFIG_CAAM_QI */
223 
224 static inline u64 caam_get_dma_mask(struct device *dev)
225 {
226 	struct device_node *nprop = dev->of_node;
227 
228 	if (caam_ptr_sz != sizeof(u64))
229 		return DMA_BIT_MASK(32);
230 
231 	if (caam_dpaa2)
232 		return DMA_BIT_MASK(49);
233 
234 	if (of_device_is_compatible(nprop, "fsl,sec-v5.0-job-ring") ||
235 	    of_device_is_compatible(nprop, "fsl,sec-v5.0"))
236 		return DMA_BIT_MASK(40);
237 
238 	return DMA_BIT_MASK(36);
239 }
240 
241 
242 #endif /* INTERN_H */
243