1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
28e8ec596SKim Phillips /*
38e8ec596SKim Phillips * CAAM/SEC 4.x driver backend
48e8ec596SKim Phillips * Private/internal definitions between modules
58e8ec596SKim Phillips *
68e8ec596SKim Phillips * Copyright 2008-2011 Freescale Semiconductor, Inc.
7*322d7475SHoria Geanta * Copyright 2019, 2023 NXP
88e8ec596SKim Phillips */
98e8ec596SKim Phillips
108e8ec596SKim Phillips #ifndef INTERN_H
118e8ec596SKim Phillips #define INTERN_H
128e8ec596SKim Phillips
1370c0cda2SAndrey Smirnov #include "ctrl.h"
14ee38767fSIuliana Prodan #include <crypto/engine.h>
1570c0cda2SAndrey Smirnov
168e8ec596SKim Phillips /* Currently comes from Kconfig param as a ^2 (driver-required) */
178e8ec596SKim Phillips #define JOBR_DEPTH (1 << CONFIG_CRYPTO_DEV_FSL_CAAM_RINGSIZE)
188e8ec596SKim Phillips
192d653936SIuliana Prodan /*
202d653936SIuliana Prodan * Maximum size for crypto-engine software queue based on Job Ring
212d653936SIuliana Prodan * size (JOBR_DEPTH) and a THRESHOLD (reserved for the non-crypto-API
222d653936SIuliana Prodan * requests that are not passed through crypto-engine)
232d653936SIuliana Prodan */
242d653936SIuliana Prodan #define THRESHOLD 15
252d653936SIuliana Prodan #define CRYPTO_ENGINE_MAX_QLEN (JOBR_DEPTH - THRESHOLD)
262d653936SIuliana Prodan
278e8ec596SKim Phillips /* Kconfig params for interrupt coalescing if selected (else zero) */
288e8ec596SKim Phillips #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_INTC
298e8ec596SKim Phillips #define JOBR_INTC JRCFG_ICEN
308e8ec596SKim Phillips #define JOBR_INTC_TIME_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_TIME_THLD
318e8ec596SKim Phillips #define JOBR_INTC_COUNT_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_COUNT_THLD
328e8ec596SKim Phillips #else
338e8ec596SKim Phillips #define JOBR_INTC 0
348e8ec596SKim Phillips #define JOBR_INTC_TIME_THLD 0
358e8ec596SKim Phillips #define JOBR_INTC_COUNT_THLD 0
368e8ec596SKim Phillips #endif
378e8ec596SKim Phillips
388e8ec596SKim Phillips /*
398e8ec596SKim Phillips * Storage for tracking each in-process entry moving across a ring
408e8ec596SKim Phillips * Each entry on an output ring needs one of these
418e8ec596SKim Phillips */
428e8ec596SKim Phillips struct caam_jrentry_info {
438e8ec596SKim Phillips void (*callbk)(struct device *dev, u32 *desc, u32 status, void *arg);
448e8ec596SKim Phillips void *cbkarg; /* Argument per ring entry */
458e8ec596SKim Phillips u32 *desc_addr_virt; /* Stored virt addr for postprocessing */
468e8ec596SKim Phillips dma_addr_t desc_addr_dma; /* Stored bus addr for done matching */
478e8ec596SKim Phillips u32 desc_size; /* Stored size for postprocessing, header derived */
488e8ec596SKim Phillips };
498e8ec596SKim Phillips
50*322d7475SHoria Geanta struct caam_jr_state {
51*322d7475SHoria Geanta dma_addr_t inpbusaddr;
52*322d7475SHoria Geanta dma_addr_t outbusaddr;
53*322d7475SHoria Geanta };
54*322d7475SHoria Geanta
55*322d7475SHoria Geanta struct caam_jr_dequeue_params {
56*322d7475SHoria Geanta struct device *dev;
57*322d7475SHoria Geanta int enable_itr;
58*322d7475SHoria Geanta };
59*322d7475SHoria Geanta
608e8ec596SKim Phillips /* Private sub-storage for a single JobR */
618e8ec596SKim Phillips struct caam_drv_private_jr {
62313ea293SRuchika Gupta struct list_head list_node; /* Job Ring device list */
63313ea293SRuchika Gupta struct device *dev;
648e8ec596SKim Phillips int ridx;
658e8ec596SKim Phillips struct caam_job_ring __iomem *rregs; /* JobR's register space */
662b163b5bSHoria Geantă struct tasklet_struct irqtask;
67*322d7475SHoria Geanta struct caam_jr_dequeue_params tasklet_params;
688e8ec596SKim Phillips int irq; /* One per queue */
691517f63cSAndrey Smirnov bool hwrng;
708e8ec596SKim Phillips
7107defbfbSRuchika Gupta /* Number of scatterlist crypt transforms active on the JobR */
7207defbfbSRuchika Gupta atomic_t tfm_count ____cacheline_aligned;
7307defbfbSRuchika Gupta
748e8ec596SKim Phillips /* Job ring info */
758e8ec596SKim Phillips struct caam_jrentry_info *entinfo; /* Alloc'ed 1 per ring entry */
768e8ec596SKim Phillips spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
7716c4dd83SVakul Garg u32 inpring_avail; /* Number of free entries in input ring */
788e8ec596SKim Phillips int head; /* entinfo (s/w ring) head index */
79dff36801SAndrey Smirnov void *inpring; /* Base of input ring, alloc
80dff36801SAndrey Smirnov * DMA-safe */
818e8ec596SKim Phillips int out_ring_read_index; /* Output index "tail" */
828e8ec596SKim Phillips int tail; /* entinfo (s/w ring) tail index */
836c5f898fSAndrey Smirnov void *outring; /* Base of output ring, DMA-safe */
84ee38767fSIuliana Prodan struct crypto_engine *engine;
85*322d7475SHoria Geanta
86*322d7475SHoria Geanta struct caam_jr_state state; /* State of the JR during PM */
87*322d7475SHoria Geanta };
88*322d7475SHoria Geanta
89*322d7475SHoria Geanta struct caam_ctl_state {
90*322d7475SHoria Geanta struct masterid deco_mid[16];
91*322d7475SHoria Geanta struct masterid jr_mid[4];
92*322d7475SHoria Geanta u32 mcr;
93*322d7475SHoria Geanta u32 scfgr;
948e8ec596SKim Phillips };
958e8ec596SKim Phillips
968e8ec596SKim Phillips /*
978e8ec596SKim Phillips * Driver-private storage for a single CAAM block instance
988e8ec596SKim Phillips */
998e8ec596SKim Phillips struct caam_drv_private {
1008e8ec596SKim Phillips /* Physical-presence section */
101fb4562b2SNitesh Narayan Lal struct caam_ctrl __iomem *ctrl; /* controller region */
102fb4562b2SNitesh Narayan Lal struct caam_deco __iomem *deco; /* DECO/CCB views */
103fb4562b2SNitesh Narayan Lal struct caam_assurance __iomem *assure;
104fb4562b2SNitesh Narayan Lal struct caam_queue_if __iomem *qi; /* QI control region */
105fb4562b2SNitesh Narayan Lal struct caam_job_ring __iomem *jr[4]; /* JobR's register space */
1068e8ec596SKim Phillips
107b2b2ee35SHoria Geantă struct iommu_domain *domain;
108b2b2ee35SHoria Geantă
1098e8ec596SKim Phillips /*
1108e8ec596SKim Phillips * Detected geometry block. Filled in from device tree if powerpc,
1118e8ec596SKim Phillips * or from register-based version detection code
1128e8ec596SKim Phillips */
1138e8ec596SKim Phillips u8 total_jobrs; /* Total Job Rings in device */
1148e8ec596SKim Phillips u8 qi_present; /* Nonzero if QI present in device */
1157a0e7d52SAhmad Fatoum u8 blob_present; /* Nonzero if BLOB support present in device */
11606d44c91SHoria Geantă u8 mc_en; /* Nonzero if MC f/w is active */
1170489929fSHoria GeantA u8 optee_en; /* Nonzero if OP-TEE f/w is active */
118da2f2a03SHoria GeantA bool pr_support; /* RNG prediction resistance available */
1198e8ec596SKim Phillips int secvio_irq; /* Security violation interrupt number */
12017157c90SRuchika Gupta int virt_en; /* Virtualization enabled in CAAM */
1219fe712dfSHoria Geantă int era; /* CAAM Era (internal HW revision) */
1228e8ec596SKim Phillips
1231005bccdSAlex Porosanu #define RNG4_MAX_HANDLES 2
124b1f996e0SAlex Porosanu /* RNG4 block */
1251005bccdSAlex Porosanu u32 rng4_sh_init; /* This bitmap shows which of the State
1261005bccdSAlex Porosanu Handles of the RNG4 block are initialized
1271005bccdSAlex Porosanu by this driver */
128b1f996e0SAlex Porosanu
12951e002e9SAndrey Smirnov struct clk_bulk_data *clks;
13051e002e9SAndrey Smirnov int num_clks;
1318e8ec596SKim Phillips /*
1328e8ec596SKim Phillips * debugfs entries for developer view into driver/device
1338e8ec596SKim Phillips * variables at runtime.
1348e8ec596SKim Phillips */
1358e8ec596SKim Phillips #ifdef CONFIG_DEBUG_FS
1368e8ec596SKim Phillips struct dentry *ctl; /* controller dir */
1378e8ec596SKim Phillips struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
1388e8ec596SKim Phillips #endif
139*322d7475SHoria Geanta
140*322d7475SHoria Geanta int caam_off_during_pm; /* If the CAAM is reset after suspend */
141*322d7475SHoria Geanta struct caam_ctl_state state; /* State of the CTL during PM */
1428e8ec596SKim Phillips };
1438e8ec596SKim Phillips
1441b46c90cSHoria Geantă #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_CRYPTO_API
1451b46c90cSHoria Geantă
1461b46c90cSHoria Geantă int caam_algapi_init(struct device *dev);
1471b46c90cSHoria Geantă void caam_algapi_exit(void);
1481b46c90cSHoria Geantă
1491b46c90cSHoria Geantă #else
1501b46c90cSHoria Geantă
caam_algapi_init(struct device * dev)1511b46c90cSHoria Geantă static inline int caam_algapi_init(struct device *dev)
1521b46c90cSHoria Geantă {
1531b46c90cSHoria Geantă return 0;
1541b46c90cSHoria Geantă }
1551b46c90cSHoria Geantă
caam_algapi_exit(void)1561b46c90cSHoria Geantă static inline void caam_algapi_exit(void)
1571b46c90cSHoria Geantă {
1581b46c90cSHoria Geantă }
1591b46c90cSHoria Geantă
1601b46c90cSHoria Geantă #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_CRYPTO_API */
1611b46c90cSHoria Geantă
1621b46c90cSHoria Geantă #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_AHASH_API
1631b46c90cSHoria Geantă
1641b46c90cSHoria Geantă int caam_algapi_hash_init(struct device *dev);
1651b46c90cSHoria Geantă void caam_algapi_hash_exit(void);
1661b46c90cSHoria Geantă
1671b46c90cSHoria Geantă #else
1681b46c90cSHoria Geantă
caam_algapi_hash_init(struct device * dev)1691b46c90cSHoria Geantă static inline int caam_algapi_hash_init(struct device *dev)
1701b46c90cSHoria Geantă {
1711b46c90cSHoria Geantă return 0;
1721b46c90cSHoria Geantă }
1731b46c90cSHoria Geantă
caam_algapi_hash_exit(void)1741b46c90cSHoria Geantă static inline void caam_algapi_hash_exit(void)
1751b46c90cSHoria Geantă {
1761b46c90cSHoria Geantă }
1771b46c90cSHoria Geantă
1781b46c90cSHoria Geantă #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_AHASH_API */
1791b46c90cSHoria Geantă
1801b46c90cSHoria Geantă #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_PKC_API
1811b46c90cSHoria Geantă
1821b46c90cSHoria Geantă int caam_pkc_init(struct device *dev);
1831b46c90cSHoria Geantă void caam_pkc_exit(void);
1841b46c90cSHoria Geantă
1851b46c90cSHoria Geantă #else
1861b46c90cSHoria Geantă
caam_pkc_init(struct device * dev)1871b46c90cSHoria Geantă static inline int caam_pkc_init(struct device *dev)
1881b46c90cSHoria Geantă {
1891b46c90cSHoria Geantă return 0;
1901b46c90cSHoria Geantă }
1911b46c90cSHoria Geantă
caam_pkc_exit(void)1921b46c90cSHoria Geantă static inline void caam_pkc_exit(void)
1931b46c90cSHoria Geantă {
1941b46c90cSHoria Geantă }
1951b46c90cSHoria Geantă
1961b46c90cSHoria Geantă #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_PKC_API */
1971b46c90cSHoria Geantă
1981b46c90cSHoria Geantă #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_API
1991b46c90cSHoria Geantă
2001b46c90cSHoria Geantă int caam_rng_init(struct device *dev);
2011517f63cSAndrey Smirnov void caam_rng_exit(struct device *dev);
2021b46c90cSHoria Geantă
2031b46c90cSHoria Geantă #else
2041b46c90cSHoria Geantă
caam_rng_init(struct device * dev)2051b46c90cSHoria Geantă static inline int caam_rng_init(struct device *dev)
2061b46c90cSHoria Geantă {
2071b46c90cSHoria Geantă return 0;
2081b46c90cSHoria Geantă }
2091b46c90cSHoria Geantă
caam_rng_exit(struct device * dev)2101517f63cSAndrey Smirnov static inline void caam_rng_exit(struct device *dev) {}
2111b46c90cSHoria Geantă
2121b46c90cSHoria Geantă #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_RNG_API */
2131b46c90cSHoria Geantă
2140aa6ac77SMeenakshi Aggarwal #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_PRNG_API
2150aa6ac77SMeenakshi Aggarwal
2160aa6ac77SMeenakshi Aggarwal int caam_prng_register(struct device *dev);
2170aa6ac77SMeenakshi Aggarwal void caam_prng_unregister(void *data);
2180aa6ac77SMeenakshi Aggarwal
2190aa6ac77SMeenakshi Aggarwal #else
2200aa6ac77SMeenakshi Aggarwal
caam_prng_register(struct device * dev)2210aa6ac77SMeenakshi Aggarwal static inline int caam_prng_register(struct device *dev)
2220aa6ac77SMeenakshi Aggarwal {
2230aa6ac77SMeenakshi Aggarwal return 0;
2240aa6ac77SMeenakshi Aggarwal }
2250aa6ac77SMeenakshi Aggarwal
caam_prng_unregister(void * data)2260aa6ac77SMeenakshi Aggarwal static inline void caam_prng_unregister(void *data) {}
2270aa6ac77SMeenakshi Aggarwal #endif /* CONFIG_CRYPTO_DEV_FSL_CAAM_PRNG_API */
2280aa6ac77SMeenakshi Aggarwal
2291b46c90cSHoria Geantă #ifdef CONFIG_CAAM_QI
2301b46c90cSHoria Geantă
2311b46c90cSHoria Geantă int caam_qi_algapi_init(struct device *dev);
2321b46c90cSHoria Geantă void caam_qi_algapi_exit(void);
2331b46c90cSHoria Geantă
2341b46c90cSHoria Geantă #else
2351b46c90cSHoria Geantă
caam_qi_algapi_init(struct device * dev)2361b46c90cSHoria Geantă static inline int caam_qi_algapi_init(struct device *dev)
2371b46c90cSHoria Geantă {
2381b46c90cSHoria Geantă return 0;
2391b46c90cSHoria Geantă }
2401b46c90cSHoria Geantă
caam_qi_algapi_exit(void)2411b46c90cSHoria Geantă static inline void caam_qi_algapi_exit(void)
2421b46c90cSHoria Geantă {
2431b46c90cSHoria Geantă }
2441b46c90cSHoria Geantă
2451b46c90cSHoria Geantă #endif /* CONFIG_CAAM_QI */
24667c2315dSHoria Geantă
caam_get_dma_mask(struct device * dev)24770c0cda2SAndrey Smirnov static inline u64 caam_get_dma_mask(struct device *dev)
24870c0cda2SAndrey Smirnov {
24970c0cda2SAndrey Smirnov struct device_node *nprop = dev->of_node;
25070c0cda2SAndrey Smirnov
251a1cf573eSAndrey Smirnov if (caam_ptr_sz != sizeof(u64))
25270c0cda2SAndrey Smirnov return DMA_BIT_MASK(32);
25370c0cda2SAndrey Smirnov
25470c0cda2SAndrey Smirnov if (caam_dpaa2)
25570c0cda2SAndrey Smirnov return DMA_BIT_MASK(49);
25670c0cda2SAndrey Smirnov
25770c0cda2SAndrey Smirnov if (of_device_is_compatible(nprop, "fsl,sec-v5.0-job-ring") ||
25870c0cda2SAndrey Smirnov of_device_is_compatible(nprop, "fsl,sec-v5.0"))
25970c0cda2SAndrey Smirnov return DMA_BIT_MASK(40);
26070c0cda2SAndrey Smirnov
26170c0cda2SAndrey Smirnov return DMA_BIT_MASK(36);
26270c0cda2SAndrey Smirnov }
26370c0cda2SAndrey Smirnov
26470c0cda2SAndrey Smirnov
2658e8ec596SKim Phillips #endif /* INTERN_H */
266