[mirror_ubuntu-bionic-kernel.git] / drivers / crypto / caam / intern.h

/*
 * CAAM/SEC 4.x driver backend
 * Private/internal definitions between modules
 *
 * Copyright 2008-2011 Freescale Semiconductor, Inc.
 *
 */

#ifndef INTERN_H
#define INTERN_H

/* Currently comes from Kconfig param as a ^2 (driver-required) */
#define JOBR_DEPTH (1 << CONFIG_CRYPTO_DEV_FSL_CAAM_RINGSIZE)

/* Kconfig params for interrupt coalescing if selected (else zero) */
#ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_INTC
#define JOBR_INTC JRCFG_ICEN
#define JOBR_INTC_TIME_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_TIME_THLD
#define JOBR_INTC_COUNT_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_COUNT_THLD
#else
#define JOBR_INTC 0
#define JOBR_INTC_TIME_THLD 0
#define JOBR_INTC_COUNT_THLD 0
#endif

/*
 * Storage for tracking each in-process entry moving across a ring
 * Each entry on an output ring needs one of these
 */
struct caam_jrentry_info {
	void (*callbk)(struct device *dev, u32 *desc, u32 status, void *arg);
	void *cbkarg;	/* Argument per ring entry */
	u32 *desc_addr_virt;	/* Stored virt addr for postprocessing */
	dma_addr_t desc_addr_dma;	/* Stored bus addr for done matching */
	u32 desc_size;	/* Stored size for postprocessing, header derived */
};

/* Private sub-storage for a single JobR */
struct caam_drv_private_jr {
	struct list_head	list_node;	/* Job Ring device list */
	struct device		*dev;
	int ridx;
	struct caam_job_ring __iomem *rregs;	/* JobR's register space */
	struct tasklet_struct irqtask;
	int irq;			/* One per queue */

	/* Number of scatterlist crypt transforms active on the JobR */
	atomic_t tfm_count ____cacheline_aligned;

	/* Job ring info */
	int ringsize;	/* Size of rings (assume input = output) */
	struct caam_jrentry_info *entinfo;	/* Alloc'ed 1 per ring entry */
	spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
	int inp_ring_write_index;	/* Input index "tail" */
	int head;			/* entinfo (s/w ring) head index */
	dma_addr_t *inpring;	/* Base of input ring, alloc DMA-safe */
	spinlock_t outlock ____cacheline_aligned; /* Output ring index lock */
	int out_ring_read_index;	/* Output index "tail" */
	int tail;			/* entinfo (s/w ring) tail index */
	struct jr_outentry *outring;	/* Base of output ring, DMA-safe */
};

/*
 * Driver-private storage for a single CAAM block instance
 */
struct caam_drv_private {

	struct device *dev;
	struct platform_device *pdev;

	/* Physical-presence section */
	struct caam_ctrl __iomem *ctrl; /* controller region */
	struct caam_deco __iomem *deco; /* DECO/CCB views */
	struct caam_assurance __iomem *assure;
	struct caam_queue_if __iomem *qi; /* QI control region */
	struct caam_job_ring __iomem *jr[4];	/* JobR's register space */

	/*
	 * Detected geometry block. Filled in from device tree if powerpc,
	 * or from register-based version detection code
	 */
	u8 total_jobrs;		/* Total Job Rings in device */
	u8 qi_present;		/* Nonzero if QI present in device */
	int secvio_irq;		/* Security violation interrupt number */
	int virt_en;		/* Virtualization enabled in CAAM */

#define	RNG4_MAX_HANDLES 2
	/* RNG4 block */
	u32 rng4_sh_init;	/* This bitmap shows which of the State
				   Handles of the RNG4 block are initialized
				   by this driver */

	struct clk *caam_ipg;
	struct clk *caam_mem;
	struct clk *caam_aclk;
	struct clk *caam_emi_slow;

	/*
	 * debugfs entries for developer view into driver/device
	 * variables at runtime.
	 */
#ifdef CONFIG_DEBUG_FS
	struct dentry *dfs_root;
	struct dentry *ctl; /* controller dir */
	struct dentry *ctl_rq_dequeued, *ctl_ob_enc_req, *ctl_ib_dec_req;
	struct dentry *ctl_ob_enc_bytes, *ctl_ob_prot_bytes;
	struct dentry *ctl_ib_dec_bytes, *ctl_ib_valid_bytes;
	struct dentry *ctl_faultaddr, *ctl_faultdetail, *ctl_faultstatus;

	struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
	struct dentry *ctl_kek, *ctl_tkek, *ctl_tdsk;
#endif
};

void caam_jr_algapi_init(struct device *dev);
void caam_jr_algapi_remove(struct device *dev);
#endif /* INTERN_H */
Commit	Line	Data
8e8ec596 KP	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
8e8ec596 KP	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 {
313ea293 RG	40	struct list_head list_node; /* Job Ring device list */
313ea293 RG	41	struct device *dev;
8e8ec596 KP	42	int ridx;
8e8ec596 KP	43	struct caam_job_ring __iomem rregs; / JobR's register space */
2b163b5b	44	struct tasklet_struct irqtask;
8e8ec596	45	int irq; /* One per queue */
8e8ec596	46
07defbfb RG	47	/* Number of scatterlist crypt transforms active on the JobR */
	48	atomic_t tfm_count ____cacheline_aligned;
	49
8e8ec596 KP	50	/* Job ring info */
	51	int ringsize; /* Size of rings (assume input = output) */
	52	struct caam_jrentry_info entinfo; / Alloc'ed 1 per ring entry */
	53	spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
	54	int inp_ring_write_index; /* Input index "tail" */
	55	int head; /* entinfo (s/w ring) head index */
	56	dma_addr_t inpring; / Base of input ring, alloc DMA-safe */
	57	spinlock_t outlock ____cacheline_aligned; /* Output ring index lock */
	58	int out_ring_read_index; /* Output index "tail" */
	59	int tail; /* entinfo (s/w ring) tail index */
	60	struct jr_outentry outring; / Base of output ring, DMA-safe */
	61	};
	62
	63	/*
	64	* Driver-private storage for a single CAAM block instance
	65	*/
	66	struct caam_drv_private {
	67
	68	struct device *dev;
8e8ec596 KP	69	struct platform_device *pdev;
	70
	71	/* Physical-presence section */
fb4562b2 NNL	72	struct caam_ctrl __iomem ctrl; / controller region */
	73	struct caam_deco __iomem deco; / DECO/CCB views */
	74	struct caam_assurance __iomem *assure;
	75	struct caam_queue_if __iomem qi; / QI control region */
	76	struct caam_job_ring __iomem jr[4]; / JobR's register space */
8e8ec596 KP	77
	78	/*
	79	* Detected geometry block. Filled in from device tree if powerpc,
	80	* or from register-based version detection code
	81	*/
	82	u8 total_jobrs; /* Total Job Rings in device */
	83	u8 qi_present; /* Nonzero if QI present in device */
	84	int secvio_irq; /* Security violation interrupt number */
17157c90	85	int virt_en; /* Virtualization enabled in CAAM */
8e8ec596	86
1005bccd	87	#define RNG4_MAX_HANDLES 2
b1f996e0	88	/* RNG4 block */
1005bccd AP	89	u32 rng4_sh_init; /* This bitmap shows which of the State
	90	Handles of the RNG4 block are initialized
	91	by this driver */
b1f996e0	92
24821c46 VM	93	struct clk *caam_ipg;
	94	struct clk *caam_mem;
	95	struct clk *caam_aclk;
	96	struct clk *caam_emi_slow;
	97
8e8ec596 KP	98	/*
	99	* debugfs entries for developer view into driver/device
	100	* variables at runtime.
	101	*/
	102	#ifdef CONFIG_DEBUG_FS
	103	struct dentry *dfs_root;
	104	struct dentry ctl; / controller dir */
	105	struct dentry ctl_rq_dequeued, ctl_ob_enc_req, *ctl_ib_dec_req;
	106	struct dentry ctl_ob_enc_bytes, ctl_ob_prot_bytes;
	107	struct dentry ctl_ib_dec_bytes, ctl_ib_valid_bytes;
	108	struct dentry ctl_faultaddr, ctl_faultdetail, *ctl_faultstatus;
	109
	110	struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
	111	struct dentry ctl_kek, ctl_tkek, *ctl_tdsk;
	112	#endif
	113	};
	114
	115	void caam_jr_algapi_init(struct device *dev);
	116	void caam_jr_algapi_remove(struct device *dev);
	117	#endif /* INTERN_H */