xref: /openbmc/linux/drivers/crypto/caam/intern.h (revision 089a49b6)
1 /*
2  * CAAM/SEC 4.x driver backend
3  * Private/internal definitions between modules
4  *
5  * Copyright 2008-2011 Freescale Semiconductor, Inc.
6  *
7  */
8 
9 #ifndef INTERN_H
10 #define INTERN_H
11 
12 /* Currently comes from Kconfig param as a ^2 (driver-required) */
13 #define JOBR_DEPTH (1 << CONFIG_CRYPTO_DEV_FSL_CAAM_RINGSIZE)
14 
15 /* Kconfig params for interrupt coalescing if selected (else zero) */
16 #ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_INTC
17 #define JOBR_INTC JRCFG_ICEN
18 #define JOBR_INTC_TIME_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_TIME_THLD
19 #define JOBR_INTC_COUNT_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_COUNT_THLD
20 #else
21 #define JOBR_INTC 0
22 #define JOBR_INTC_TIME_THLD 0
23 #define JOBR_INTC_COUNT_THLD 0
24 #endif
25 
26 /*
27  * Storage for tracking each in-process entry moving across a ring
28  * Each entry on an output ring needs one of these
29  */
30 struct caam_jrentry_info {
31 	void (*callbk)(struct device *dev, u32 *desc, u32 status, void *arg);
32 	void *cbkarg;	/* Argument per ring entry */
33 	u32 *desc_addr_virt;	/* Stored virt addr for postprocessing */
34 	dma_addr_t desc_addr_dma;	/* Stored bus addr for done matching */
35 	u32 desc_size;	/* Stored size for postprocessing, header derived */
36 };
37 
38 /* Private sub-storage for a single JobR */
39 struct caam_drv_private_jr {
40 	struct device *parentdev;	/* points back to controller dev */
41 	struct platform_device *jr_pdev;/* points to platform device for JR */
42 	int ridx;
43 	struct caam_job_ring __iomem *rregs;	/* JobR's register space */
44 	struct tasklet_struct irqtask;
45 	int irq;			/* One per queue */
46 
47 	/* Job ring info */
48 	int ringsize;	/* Size of rings (assume input = output) */
49 	struct caam_jrentry_info *entinfo;	/* Alloc'ed 1 per ring entry */
50 	spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
51 	int inp_ring_write_index;	/* Input index "tail" */
52 	int head;			/* entinfo (s/w ring) head index */
53 	dma_addr_t *inpring;	/* Base of input ring, alloc DMA-safe */
54 	spinlock_t outlock ____cacheline_aligned; /* Output ring index lock */
55 	int out_ring_read_index;	/* Output index "tail" */
56 	int tail;			/* entinfo (s/w ring) tail index */
57 	struct jr_outentry *outring;	/* Base of output ring, DMA-safe */
58 };
59 
60 /*
61  * Driver-private storage for a single CAAM block instance
62  */
63 struct caam_drv_private {
64 
65 	struct device *dev;
66 	struct device **jrdev; /* Alloc'ed array per sub-device */
67 	struct platform_device *pdev;
68 
69 	/* Physical-presence section */
70 	struct caam_ctrl *ctrl; /* controller region */
71 	struct caam_deco **deco; /* DECO/CCB views */
72 	struct caam_assurance *ac;
73 	struct caam_queue_if *qi; /* QI control region */
74 
75 	/*
76 	 * Detected geometry block. Filled in from device tree if powerpc,
77 	 * or from register-based version detection code
78 	 */
79 	u8 total_jobrs;		/* Total Job Rings in device */
80 	u8 qi_present;		/* Nonzero if QI present in device */
81 	int secvio_irq;		/* Security violation interrupt number */
82 
83 	/* which jr allocated to scatterlist crypto */
84 	atomic_t tfm_count ____cacheline_aligned;
85 	/* list of registered crypto algorithms (mk generic context handle?) */
86 	struct list_head alg_list;
87 	/* list of registered hash algorithms (mk generic context handle?) */
88 	struct list_head hash_list;
89 
90 	/*
91 	 * debugfs entries for developer view into driver/device
92 	 * variables at runtime.
93 	 */
94 #ifdef CONFIG_DEBUG_FS
95 	struct dentry *dfs_root;
96 	struct dentry *ctl; /* controller dir */
97 	struct dentry *ctl_rq_dequeued, *ctl_ob_enc_req, *ctl_ib_dec_req;
98 	struct dentry *ctl_ob_enc_bytes, *ctl_ob_prot_bytes;
99 	struct dentry *ctl_ib_dec_bytes, *ctl_ib_valid_bytes;
100 	struct dentry *ctl_faultaddr, *ctl_faultdetail, *ctl_faultstatus;
101 
102 	struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
103 	struct dentry *ctl_kek, *ctl_tkek, *ctl_tdsk;
104 #endif
105 };
106 
107 void caam_jr_algapi_init(struct device *dev);
108 void caam_jr_algapi_remove(struct device *dev);
109 #endif /* INTERN_H */
110