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

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * 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 {
#ifdef CONFIG_CAAM_QI
	struct device *qidev;
#endif

	/* 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 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);

#ifdef CONFIG_DEBUG_FS
static int caam_debugfs_u64_get(void *data, u64 *val)
{
	*val = caam64_to_cpu(*(u64 *)data);
	return 0;
}

static int caam_debugfs_u32_get(void *data, u64 *val)
{
	*val = caam32_to_cpu(*(u32 *)data);
	return 0;
}

DEFINE_SIMPLE_ATTRIBUTE(caam_fops_u32_ro, caam_debugfs_u32_get, NULL, "%llu\n");
DEFINE_SIMPLE_ATTRIBUTE(caam_fops_u64_ro, caam_debugfs_u64_get, NULL, "%llu\n");
#endif

#endif /* INTERN_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
8e8ec596 KP	2	/*
	3	* CAAM/SEC 4.x driver backend
	4	* Private/internal definitions between modules
	5	*
	6	* Copyright 2008-2011 Freescale Semiconductor, Inc.
	7	*
	8	*/
	9
	10	#ifndef INTERN_H
	11	#define INTERN_H
	12
8e8ec596 KP	13	/* Currently comes from Kconfig param as a ^2 (driver-required) */
	14	#define JOBR_DEPTH (1 << CONFIG_CRYPTO_DEV_FSL_CAAM_RINGSIZE)
	15
	16	/* Kconfig params for interrupt coalescing if selected (else zero) */
	17	#ifdef CONFIG_CRYPTO_DEV_FSL_CAAM_INTC
	18	#define JOBR_INTC JRCFG_ICEN
	19	#define JOBR_INTC_TIME_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_TIME_THLD
	20	#define JOBR_INTC_COUNT_THLD CONFIG_CRYPTO_DEV_FSL_CAAM_INTC_COUNT_THLD
	21	#else
	22	#define JOBR_INTC 0
	23	#define JOBR_INTC_TIME_THLD 0
	24	#define JOBR_INTC_COUNT_THLD 0
	25	#endif
	26
	27	/*
	28	* Storage for tracking each in-process entry moving across a ring
	29	* Each entry on an output ring needs one of these
	30	*/
	31	struct caam_jrentry_info {
	32	void (callbk)(struct device dev, u32 desc, u32 status, void arg);
	33	void cbkarg; / Argument per ring entry */
	34	u32 desc_addr_virt; / Stored virt addr for postprocessing */
	35	dma_addr_t desc_addr_dma; /* Stored bus addr for done matching */
	36	u32 desc_size; /* Stored size for postprocessing, header derived */
	37	};
	38
	39	/* Private sub-storage for a single JobR */
	40	struct caam_drv_private_jr {
313ea293 RG	41	struct list_head list_node; /* Job Ring device list */
313ea293 RG	42	struct device *dev;
8e8ec596 KP	43	int ridx;
8e8ec596 KP	44	struct caam_job_ring __iomem rregs; / JobR's register space */
2b163b5b	45	struct tasklet_struct irqtask;
8e8ec596	46	int irq; /* One per queue */
8e8ec596	47
07defbfb RG	48	/* Number of scatterlist crypt transforms active on the JobR */
	49	atomic_t tfm_count ____cacheline_aligned;
	50
8e8ec596 KP	51	/* Job ring info */
	52	int ringsize; /* Size of rings (assume input = output) */
	53	struct caam_jrentry_info entinfo; / Alloc'ed 1 per ring entry */
	54	spinlock_t inplock ____cacheline_aligned; /* Input ring index lock */
	55	int inp_ring_write_index; /* Input index "tail" */
	56	int head; /* entinfo (s/w ring) head index */
	57	dma_addr_t inpring; / Base of input ring, alloc DMA-safe */
	58	spinlock_t outlock ____cacheline_aligned; /* Output ring index lock */
	59	int out_ring_read_index; /* Output index "tail" */
	60	int tail; /* entinfo (s/w ring) tail index */
	61	struct jr_outentry outring; / Base of output ring, DMA-safe */
	62	};
	63
	64	/*
	65	* Driver-private storage for a single CAAM block instance
	66	*/
	67	struct caam_drv_private {
67c2315d HG	68	#ifdef CONFIG_CAAM_QI
	69	struct device *qidev;
	70	#endif
8e8ec596 KP	71
8e8ec596 KP	72	/* Physical-presence section */
fb4562b2 NNL	73	struct caam_ctrl __iomem ctrl; / controller region */
	74	struct caam_deco __iomem deco; / DECO/CCB views */
	75	struct caam_assurance __iomem *assure;
	76	struct caam_queue_if __iomem qi; / QI control region */
	77	struct caam_job_ring __iomem jr[4]; / JobR's register space */
8e8ec596 KP	78
	79	/*
	80	* Detected geometry block. Filled in from device tree if powerpc,
	81	* or from register-based version detection code
	82	*/
	83	u8 total_jobrs; /* Total Job Rings in device */
	84	u8 qi_present; /* Nonzero if QI present in device */
	85	int secvio_irq; /* Security violation interrupt number */
17157c90	86	int virt_en; /* Virtualization enabled in CAAM */
8e8ec596	87
1005bccd	88	#define RNG4_MAX_HANDLES 2
b1f996e0	89	/* RNG4 block */
1005bccd AP	90	u32 rng4_sh_init; /* This bitmap shows which of the State
	91	Handles of the RNG4 block are initialized
	92	by this driver */
b1f996e0	93
24821c46 VM	94	struct clk *caam_ipg;
	95	struct clk *caam_mem;
	96	struct clk *caam_aclk;
	97	struct clk *caam_emi_slow;
	98
8e8ec596 KP	99	/*
	100	* debugfs entries for developer view into driver/device
	101	* variables at runtime.
	102	*/
	103	#ifdef CONFIG_DEBUG_FS
	104	struct dentry *dfs_root;
	105	struct dentry ctl; / controller dir */
8e8ec596 KP	106	struct debugfs_blob_wrapper ctl_kek_wrap, ctl_tkek_wrap, ctl_tdsk_wrap;
	107	struct dentry ctl_kek, ctl_tkek, *ctl_tdsk;
	108	#endif
	109	};
	110
	111	void caam_jr_algapi_init(struct device *dev);
	112	void caam_jr_algapi_remove(struct device *dev);
67c2315d HG	113
	114	#ifdef CONFIG_DEBUG_FS
	115	static int caam_debugfs_u64_get(void data, u64 val)
	116	{
	117	val = caam64_to_cpu((u64 *)data);
	118	return 0;
	119	}
	120
	121	static int caam_debugfs_u32_get(void data, u64 val)
	122	{
	123	val = caam32_to_cpu((u32 *)data);
	124	return 0;
	125	}
	126
	127	DEFINE_SIMPLE_ATTRIBUTE(caam_fops_u32_ro, caam_debugfs_u32_get, NULL, "%llu\n");
	128	DEFINE_SIMPLE_ATTRIBUTE(caam_fops_u64_ro, caam_debugfs_u64_get, NULL, "%llu\n");
	129	#endif
	130
8e8ec596	131	#endif /* INTERN_H */