xref: /openbmc/linux/drivers/crypto/ccp/ccp-dev.h (revision 7b537b24e76a1e8e6d7ea91483a45d5b1426809b)
163b94509STom Lendacky /*
263b94509STom Lendacky  * AMD Cryptographic Coprocessor (CCP) driver
363b94509STom Lendacky  *
4553d2374SGary R Hook  * Copyright (C) 2013,2016 Advanced Micro Devices, Inc.
563b94509STom Lendacky  *
663b94509STom Lendacky  * Author: Tom Lendacky <thomas.lendacky@amd.com>
7fba8855cSGary R Hook  * Author: Gary R Hook <gary.hook@amd.com>
863b94509STom Lendacky  *
963b94509STom Lendacky  * This program is free software; you can redistribute it and/or modify
1063b94509STom Lendacky  * it under the terms of the GNU General Public License version 2 as
1163b94509STom Lendacky  * published by the Free Software Foundation.
1263b94509STom Lendacky  */
1363b94509STom Lendacky 
1463b94509STom Lendacky #ifndef __CCP_DEV_H__
1563b94509STom Lendacky #define __CCP_DEV_H__
1663b94509STom Lendacky 
1763b94509STom Lendacky #include <linux/device.h>
1863b94509STom Lendacky #include <linux/pci.h>
1963b94509STom Lendacky #include <linux/spinlock.h>
2063b94509STom Lendacky #include <linux/mutex.h>
2163b94509STom Lendacky #include <linux/list.h>
2263b94509STom Lendacky #include <linux/wait.h>
2363b94509STom Lendacky #include <linux/dmapool.h>
2463b94509STom Lendacky #include <linux/hw_random.h>
258db88467STom Lendacky #include <linux/bitops.h>
2658ea8abfSGary R Hook #include <linux/interrupt.h>
2758ea8abfSGary R Hook #include <linux/irqreturn.h>
2858ea8abfSGary R Hook #include <linux/dmaengine.h>
2963b94509STom Lendacky 
30553d2374SGary R Hook #define MAX_CCP_NAME_LEN		16
3163b94509STom Lendacky #define MAX_DMAPOOL_NAME_LEN		32
3263b94509STom Lendacky 
3363b94509STom Lendacky #define MAX_HW_QUEUES			5
3463b94509STom Lendacky #define MAX_CMD_QLEN			100
3563b94509STom Lendacky 
3663b94509STom Lendacky #define TRNG_RETRIES			10
3763b94509STom Lendacky 
38126ae9adSTom Lendacky #define CACHE_NONE			0x00
39c4f4b325STom Lendacky #define CACHE_WB_NO_ALLOC		0xb7
40c4f4b325STom Lendacky 
4163b94509STom Lendacky /****** Register Mappings ******/
4263b94509STom Lendacky #define Q_MASK_REG			0x000
4363b94509STom Lendacky #define TRNG_OUT_REG			0x00c
4463b94509STom Lendacky #define IRQ_MASK_REG			0x040
4563b94509STom Lendacky #define IRQ_STATUS_REG			0x200
4663b94509STom Lendacky 
4763b94509STom Lendacky #define DEL_CMD_Q_JOB			0x124
4863b94509STom Lendacky #define DEL_Q_ACTIVE			0x00000200
4963b94509STom Lendacky #define DEL_Q_ID_SHIFT			6
5063b94509STom Lendacky 
5163b94509STom Lendacky #define CMD_REQ0			0x180
5263b94509STom Lendacky #define CMD_REQ_INCR			0x04
5363b94509STom Lendacky 
5463b94509STom Lendacky #define CMD_Q_STATUS_BASE		0x210
5563b94509STom Lendacky #define CMD_Q_INT_STATUS_BASE		0x214
5663b94509STom Lendacky #define CMD_Q_STATUS_INCR		0x20
5763b94509STom Lendacky 
58c4f4b325STom Lendacky #define CMD_Q_CACHE_BASE		0x228
5963b94509STom Lendacky #define CMD_Q_CACHE_INC			0x20
6063b94509STom Lendacky 
618db88467STom Lendacky #define CMD_Q_ERROR(__qs)		((__qs) & 0x0000003f)
628db88467STom Lendacky #define CMD_Q_DEPTH(__qs)		(((__qs) >> 12) & 0x0000000f)
6363b94509STom Lendacky 
644b394a23SGary R Hook /* ------------------------ CCP Version 5 Specifics ------------------------ */
654b394a23SGary R Hook #define CMD5_QUEUE_MASK_OFFSET		0x00
66e14e7d12SGary R Hook #define	CMD5_QUEUE_PRIO_OFFSET		0x04
674b394a23SGary R Hook #define CMD5_REQID_CONFIG_OFFSET	0x08
68e14e7d12SGary R Hook #define	CMD5_CMD_TIMEOUT_OFFSET		0x10
694b394a23SGary R Hook #define LSB_PUBLIC_MASK_LO_OFFSET	0x18
704b394a23SGary R Hook #define LSB_PUBLIC_MASK_HI_OFFSET	0x1C
714b394a23SGary R Hook #define LSB_PRIVATE_MASK_LO_OFFSET	0x20
724b394a23SGary R Hook #define LSB_PRIVATE_MASK_HI_OFFSET	0x24
734b394a23SGary R Hook 
744b394a23SGary R Hook #define CMD5_Q_CONTROL_BASE		0x0000
754b394a23SGary R Hook #define CMD5_Q_TAIL_LO_BASE		0x0004
764b394a23SGary R Hook #define CMD5_Q_HEAD_LO_BASE		0x0008
774b394a23SGary R Hook #define CMD5_Q_INT_ENABLE_BASE		0x000C
784b394a23SGary R Hook #define CMD5_Q_INTERRUPT_STATUS_BASE	0x0010
794b394a23SGary R Hook 
804b394a23SGary R Hook #define CMD5_Q_STATUS_BASE		0x0100
814b394a23SGary R Hook #define CMD5_Q_INT_STATUS_BASE		0x0104
824b394a23SGary R Hook #define CMD5_Q_DMA_STATUS_BASE		0x0108
834b394a23SGary R Hook #define CMD5_Q_DMA_READ_STATUS_BASE	0x010C
844b394a23SGary R Hook #define CMD5_Q_DMA_WRITE_STATUS_BASE	0x0110
854b394a23SGary R Hook #define CMD5_Q_ABORT_BASE		0x0114
864b394a23SGary R Hook #define CMD5_Q_AX_CACHE_BASE		0x0118
874b394a23SGary R Hook 
88e14e7d12SGary R Hook #define	CMD5_CONFIG_0_OFFSET		0x6000
89e14e7d12SGary R Hook #define	CMD5_TRNG_CTL_OFFSET		0x6008
90e14e7d12SGary R Hook #define	CMD5_AES_MASK_OFFSET		0x6010
91e14e7d12SGary R Hook #define	CMD5_CLK_GATE_CTL_OFFSET	0x603C
92e14e7d12SGary R Hook 
934b394a23SGary R Hook /* Address offset between two virtual queue registers */
944b394a23SGary R Hook #define CMD5_Q_STATUS_INCR		0x1000
954b394a23SGary R Hook 
964b394a23SGary R Hook /* Bit masks */
974b394a23SGary R Hook #define CMD5_Q_RUN			0x1
984b394a23SGary R Hook #define CMD5_Q_HALT			0x2
994b394a23SGary R Hook #define CMD5_Q_MEM_LOCATION		0x4
1004b394a23SGary R Hook #define CMD5_Q_SIZE			0x1F
1014b394a23SGary R Hook #define CMD5_Q_SHIFT			3
1024b394a23SGary R Hook #define COMMANDS_PER_QUEUE		16
1034b394a23SGary R Hook #define QUEUE_SIZE_VAL			((ffs(COMMANDS_PER_QUEUE) - 2) & \
1044b394a23SGary R Hook 					  CMD5_Q_SIZE)
1054b394a23SGary R Hook #define Q_PTR_MASK			(2 << (QUEUE_SIZE_VAL + 5) - 1)
1064b394a23SGary R Hook #define Q_DESC_SIZE			sizeof(struct ccp5_desc)
1074b394a23SGary R Hook #define Q_SIZE(n)			(COMMANDS_PER_QUEUE*(n))
1084b394a23SGary R Hook 
1094b394a23SGary R Hook #define INT_COMPLETION			0x1
1104b394a23SGary R Hook #define INT_ERROR			0x2
1114b394a23SGary R Hook #define INT_QUEUE_STOPPED		0x4
11256467cb1SGary R Hook #define	INT_EMPTY_QUEUE			0x8
11356467cb1SGary R Hook #define SUPPORTED_INTERRUPTS		(INT_COMPLETION | INT_ERROR)
1144b394a23SGary R Hook 
1154b394a23SGary R Hook #define LSB_REGION_WIDTH		5
1164b394a23SGary R Hook #define MAX_LSB_CNT			8
1174b394a23SGary R Hook 
1184b394a23SGary R Hook #define LSB_SIZE			16
1194b394a23SGary R Hook #define LSB_ITEM_SIZE			32
1204b394a23SGary R Hook #define PLSB_MAP_SIZE			(LSB_SIZE)
1214b394a23SGary R Hook #define SLSB_MAP_SIZE			(MAX_LSB_CNT * LSB_SIZE)
1224b394a23SGary R Hook 
1234b394a23SGary R Hook #define LSB_ENTRY_NUMBER(LSB_ADDR)	(LSB_ADDR / LSB_ITEM_SIZE)
1244b394a23SGary R Hook 
1254b394a23SGary R Hook /* ------------------------ CCP Version 3 Specifics ------------------------ */
12663b94509STom Lendacky #define REQ0_WAIT_FOR_WRITE		0x00000004
12763b94509STom Lendacky #define REQ0_INT_ON_COMPLETE		0x00000002
12863b94509STom Lendacky #define REQ0_STOP_ON_COMPLETE		0x00000001
12963b94509STom Lendacky 
13063b94509STom Lendacky #define REQ0_CMD_Q_SHIFT		9
13163b94509STom Lendacky #define REQ0_JOBID_SHIFT		3
13263b94509STom Lendacky 
13363b94509STom Lendacky /****** REQ1 Related Values ******/
13463b94509STom Lendacky #define REQ1_PROTECT_SHIFT		27
13563b94509STom Lendacky #define REQ1_ENGINE_SHIFT		23
13663b94509STom Lendacky #define REQ1_KEY_KSB_SHIFT		2
13763b94509STom Lendacky 
13863b94509STom Lendacky #define REQ1_EOM			0x00000002
13963b94509STom Lendacky #define REQ1_INIT			0x00000001
14063b94509STom Lendacky 
14163b94509STom Lendacky /* AES Related Values */
14263b94509STom Lendacky #define REQ1_AES_TYPE_SHIFT		21
14363b94509STom Lendacky #define REQ1_AES_MODE_SHIFT		18
14463b94509STom Lendacky #define REQ1_AES_ACTION_SHIFT		17
14563b94509STom Lendacky #define REQ1_AES_CFB_SIZE_SHIFT		10
14663b94509STom Lendacky 
14763b94509STom Lendacky /* XTS-AES Related Values */
14863b94509STom Lendacky #define REQ1_XTS_AES_SIZE_SHIFT		10
14963b94509STom Lendacky 
15063b94509STom Lendacky /* SHA Related Values */
15163b94509STom Lendacky #define REQ1_SHA_TYPE_SHIFT		21
15263b94509STom Lendacky 
15363b94509STom Lendacky /* RSA Related Values */
15463b94509STom Lendacky #define REQ1_RSA_MOD_SIZE_SHIFT		10
15563b94509STom Lendacky 
15663b94509STom Lendacky /* Pass-Through Related Values */
15763b94509STom Lendacky #define REQ1_PT_BW_SHIFT		12
15863b94509STom Lendacky #define REQ1_PT_BS_SHIFT		10
15963b94509STom Lendacky 
16063b94509STom Lendacky /* ECC Related Values */
16163b94509STom Lendacky #define REQ1_ECC_AFFINE_CONVERT		0x00200000
16263b94509STom Lendacky #define REQ1_ECC_FUNCTION_SHIFT		18
16363b94509STom Lendacky 
16463b94509STom Lendacky /****** REQ4 Related Values ******/
16563b94509STom Lendacky #define REQ4_KSB_SHIFT			18
16663b94509STom Lendacky #define REQ4_MEMTYPE_SHIFT		16
16763b94509STom Lendacky 
16863b94509STom Lendacky /****** REQ6 Related Values ******/
16963b94509STom Lendacky #define REQ6_MEMTYPE_SHIFT		16
17063b94509STom Lendacky 
17163b94509STom Lendacky /****** Key Storage Block ******/
17263b94509STom Lendacky #define KSB_START			77
17363b94509STom Lendacky #define KSB_END				127
17463b94509STom Lendacky #define KSB_COUNT			(KSB_END - KSB_START + 1)
175956ee21aSGary R Hook #define CCP_SB_BITS			256
17663b94509STom Lendacky 
17763b94509STom Lendacky #define CCP_JOBID_MASK			0x0000003f
17863b94509STom Lendacky 
1794b394a23SGary R Hook /* ------------------------ General CCP Defines ------------------------ */
1804b394a23SGary R Hook 
181efc989fcSGary R Hook #define	CCP_DMA_DFLT			0x0
182efc989fcSGary R Hook #define	CCP_DMA_PRIV			0x1
183efc989fcSGary R Hook #define	CCP_DMA_PUB			0x2
184efc989fcSGary R Hook 
18563b94509STom Lendacky #define CCP_DMAPOOL_MAX_SIZE		64
1868db88467STom Lendacky #define CCP_DMAPOOL_ALIGN		BIT(5)
18763b94509STom Lendacky 
18863b94509STom Lendacky #define CCP_REVERSE_BUF_SIZE		64
18963b94509STom Lendacky 
190956ee21aSGary R Hook #define CCP_AES_KEY_SB_COUNT		1
191956ee21aSGary R Hook #define CCP_AES_CTX_SB_COUNT		1
19263b94509STom Lendacky 
193956ee21aSGary R Hook #define CCP_XTS_AES_KEY_SB_COUNT	1
194956ee21aSGary R Hook #define CCP_XTS_AES_CTX_SB_COUNT	1
19563b94509STom Lendacky 
196990672d4SGary R Hook #define CCP_DES3_KEY_SB_COUNT		1
197990672d4SGary R Hook #define CCP_DES3_CTX_SB_COUNT		1
198990672d4SGary R Hook 
199956ee21aSGary R Hook #define CCP_SHA_SB_COUNT		1
20063b94509STom Lendacky 
20163b94509STom Lendacky #define CCP_RSA_MAX_WIDTH		4096
20263b94509STom Lendacky 
20363b94509STom Lendacky #define CCP_PASSTHRU_BLOCKSIZE		256
20463b94509STom Lendacky #define CCP_PASSTHRU_MASKSIZE		32
205956ee21aSGary R Hook #define CCP_PASSTHRU_SB_COUNT		1
20663b94509STom Lendacky 
20763b94509STom Lendacky #define CCP_ECC_MODULUS_BYTES		48      /* 384-bits */
20863b94509STom Lendacky #define CCP_ECC_MAX_OPERANDS		6
20963b94509STom Lendacky #define CCP_ECC_MAX_OUTPUTS		3
21063b94509STom Lendacky #define CCP_ECC_SRC_BUF_SIZE		448
21163b94509STom Lendacky #define CCP_ECC_DST_BUF_SIZE		192
21263b94509STom Lendacky #define CCP_ECC_OPERAND_SIZE		64
21363b94509STom Lendacky #define CCP_ECC_OUTPUT_SIZE		64
21463b94509STom Lendacky #define CCP_ECC_RESULT_OFFSET		60
21563b94509STom Lendacky #define CCP_ECC_RESULT_SUCCESS		0x0001
21663b94509STom Lendacky 
217956ee21aSGary R Hook #define CCP_SB_BYTES			32
218956ee21aSGary R Hook 
219ea0375afSGary R Hook struct ccp_op;
22063b94509STom Lendacky struct ccp_device;
22163b94509STom Lendacky struct ccp_cmd;
2224b394a23SGary R Hook struct ccp_fns;
22363b94509STom Lendacky 
22458ea8abfSGary R Hook struct ccp_dma_cmd {
22558ea8abfSGary R Hook 	struct list_head entry;
22658ea8abfSGary R Hook 
22758ea8abfSGary R Hook 	struct ccp_cmd ccp_cmd;
22858ea8abfSGary R Hook };
22958ea8abfSGary R Hook 
23058ea8abfSGary R Hook struct ccp_dma_desc {
23158ea8abfSGary R Hook 	struct list_head entry;
23258ea8abfSGary R Hook 
23358ea8abfSGary R Hook 	struct ccp_device *ccp;
23458ea8abfSGary R Hook 
23558ea8abfSGary R Hook 	struct list_head pending;
23658ea8abfSGary R Hook 	struct list_head active;
23758ea8abfSGary R Hook 
23858ea8abfSGary R Hook 	enum dma_status status;
23958ea8abfSGary R Hook 	struct dma_async_tx_descriptor tx_desc;
24058ea8abfSGary R Hook 	size_t len;
24158ea8abfSGary R Hook };
24258ea8abfSGary R Hook 
24358ea8abfSGary R Hook struct ccp_dma_chan {
24458ea8abfSGary R Hook 	struct ccp_device *ccp;
24558ea8abfSGary R Hook 
24658ea8abfSGary R Hook 	spinlock_t lock;
247e5da5c56SGary R Hook 	struct list_head created;
24858ea8abfSGary R Hook 	struct list_head pending;
24958ea8abfSGary R Hook 	struct list_head active;
25058ea8abfSGary R Hook 	struct list_head complete;
25158ea8abfSGary R Hook 
25258ea8abfSGary R Hook 	struct tasklet_struct cleanup_tasklet;
25358ea8abfSGary R Hook 
25458ea8abfSGary R Hook 	enum dma_status status;
25558ea8abfSGary R Hook 	struct dma_chan dma_chan;
25658ea8abfSGary R Hook };
25758ea8abfSGary R Hook 
25863b94509STom Lendacky struct ccp_cmd_queue {
25963b94509STom Lendacky 	struct ccp_device *ccp;
26063b94509STom Lendacky 
26163b94509STom Lendacky 	/* Queue identifier */
26263b94509STom Lendacky 	u32 id;
26363b94509STom Lendacky 
26463b94509STom Lendacky 	/* Queue dma pool */
26563b94509STom Lendacky 	struct dma_pool *dma_pool;
26663b94509STom Lendacky 
2674b394a23SGary R Hook 	/* Queue base address (not neccessarily aligned)*/
2684b394a23SGary R Hook 	struct ccp5_desc *qbase;
2694b394a23SGary R Hook 
2704b394a23SGary R Hook 	/* Aligned queue start address (per requirement) */
2714b394a23SGary R Hook 	struct mutex q_mutex ____cacheline_aligned;
2724b394a23SGary R Hook 	unsigned int qidx;
2734b394a23SGary R Hook 
2744b394a23SGary R Hook 	/* Version 5 has different requirements for queue memory */
2754b394a23SGary R Hook 	unsigned int qsize;
2764b394a23SGary R Hook 	dma_addr_t qbase_dma;
2774b394a23SGary R Hook 	dma_addr_t qdma_tail;
2784b394a23SGary R Hook 
279956ee21aSGary R Hook 	/* Per-queue reserved storage block(s) */
280956ee21aSGary R Hook 	u32 sb_key;
281956ee21aSGary R Hook 	u32 sb_ctx;
28263b94509STom Lendacky 
2834b394a23SGary R Hook 	/* Bitmap of LSBs that can be accessed by this queue */
2844b394a23SGary R Hook 	DECLARE_BITMAP(lsbmask, MAX_LSB_CNT);
2854b394a23SGary R Hook 	/* Private LSB that is assigned to this queue, or -1 if none.
2864b394a23SGary R Hook 	 * Bitmap for my private LSB, unused otherwise
2874b394a23SGary R Hook 	 */
2883cf79968SGary R Hook 	int lsb;
2894b394a23SGary R Hook 	DECLARE_BITMAP(lsbmap, PLSB_MAP_SIZE);
2904b394a23SGary R Hook 
29163b94509STom Lendacky 	/* Queue processing thread */
29263b94509STom Lendacky 	struct task_struct *kthread;
29363b94509STom Lendacky 	unsigned int active;
29463b94509STom Lendacky 	unsigned int suspended;
29563b94509STom Lendacky 
29663b94509STom Lendacky 	/* Number of free command slots available */
29763b94509STom Lendacky 	unsigned int free_slots;
29863b94509STom Lendacky 
29963b94509STom Lendacky 	/* Interrupt masks */
30063b94509STom Lendacky 	u32 int_ok;
30163b94509STom Lendacky 	u32 int_err;
30263b94509STom Lendacky 
30363b94509STom Lendacky 	/* Register addresses for queue */
3044b394a23SGary R Hook 	void __iomem *reg_control;
3054b394a23SGary R Hook 	void __iomem *reg_tail_lo;
3064b394a23SGary R Hook 	void __iomem *reg_head_lo;
3074b394a23SGary R Hook 	void __iomem *reg_int_enable;
3084b394a23SGary R Hook 	void __iomem *reg_interrupt_status;
30963b94509STom Lendacky 	void __iomem *reg_status;
31063b94509STom Lendacky 	void __iomem *reg_int_status;
3114b394a23SGary R Hook 	void __iomem *reg_dma_status;
3124b394a23SGary R Hook 	void __iomem *reg_dma_read_status;
3134b394a23SGary R Hook 	void __iomem *reg_dma_write_status;
3144b394a23SGary R Hook 	u32 qcontrol; /* Cached control register */
31563b94509STom Lendacky 
31663b94509STom Lendacky 	/* Status values from job */
31763b94509STom Lendacky 	u32 int_status;
31863b94509STom Lendacky 	u32 q_status;
31963b94509STom Lendacky 	u32 q_int_status;
32063b94509STom Lendacky 	u32 cmd_error;
32163b94509STom Lendacky 
32263b94509STom Lendacky 	/* Interrupt wait queue */
32363b94509STom Lendacky 	wait_queue_head_t int_queue;
32463b94509STom Lendacky 	unsigned int int_rcvd;
32563b94509STom Lendacky } ____cacheline_aligned;
32663b94509STom Lendacky 
32763b94509STom Lendacky struct ccp_device {
328553d2374SGary R Hook 	struct list_head entry;
329553d2374SGary R Hook 
330c7019c4dSGary R Hook 	struct ccp_vdata *vdata;
331553d2374SGary R Hook 	unsigned int ord;
332553d2374SGary R Hook 	char name[MAX_CCP_NAME_LEN];
333553d2374SGary R Hook 	char rngname[MAX_CCP_NAME_LEN];
334553d2374SGary R Hook 
33563b94509STom Lendacky 	struct device *dev;
33663b94509STom Lendacky 
337fa242e80SGary R Hook 	/* Bus specific device information
33863b94509STom Lendacky 	 */
33963b94509STom Lendacky 	void *dev_specific;
34063b94509STom Lendacky 	int (*get_irq)(struct ccp_device *ccp);
34163b94509STom Lendacky 	void (*free_irq)(struct ccp_device *ccp);
342*7b537b24SGary R Hook 	unsigned int qim;
3433d77565bSTom Lendacky 	unsigned int irq;
344*7b537b24SGary R Hook 	bool use_tasklet;
345*7b537b24SGary R Hook 	struct tasklet_struct irq_tasklet;
34663b94509STom Lendacky 
347fa242e80SGary R Hook 	/* I/O area used for device communication. The register mapping
34863b94509STom Lendacky 	 * starts at an offset into the mapped bar.
34963b94509STom Lendacky 	 *   The CMD_REQx registers and the Delete_Cmd_Queue_Job register
35063b94509STom Lendacky 	 *   need to be protected while a command queue thread is accessing
35163b94509STom Lendacky 	 *   them.
35263b94509STom Lendacky 	 */
35363b94509STom Lendacky 	struct mutex req_mutex ____cacheline_aligned;
35463b94509STom Lendacky 	void __iomem *io_map;
35563b94509STom Lendacky 	void __iomem *io_regs;
35663b94509STom Lendacky 
357fa242e80SGary R Hook 	/* Master lists that all cmds are queued on. Because there can be
35863b94509STom Lendacky 	 * more than one CCP command queue that can process a cmd a separate
35963b94509STom Lendacky 	 * backlog list is neeeded so that the backlog completion call
36063b94509STom Lendacky 	 * completes before the cmd is available for execution.
36163b94509STom Lendacky 	 */
36263b94509STom Lendacky 	spinlock_t cmd_lock ____cacheline_aligned;
36363b94509STom Lendacky 	unsigned int cmd_count;
36463b94509STom Lendacky 	struct list_head cmd;
36563b94509STom Lendacky 	struct list_head backlog;
36663b94509STom Lendacky 
367fa242e80SGary R Hook 	/* The command queues. These represent the queues available on the
36863b94509STom Lendacky 	 * CCP that are available for processing cmds
36963b94509STom Lendacky 	 */
37063b94509STom Lendacky 	struct ccp_cmd_queue cmd_q[MAX_HW_QUEUES];
37163b94509STom Lendacky 	unsigned int cmd_q_count;
37263b94509STom Lendacky 
373fa242e80SGary R Hook 	/* Support for the CCP True RNG
37463b94509STom Lendacky 	 */
37563b94509STom Lendacky 	struct hwrng hwrng;
37663b94509STom Lendacky 	unsigned int hwrng_retries;
37763b94509STom Lendacky 
378fa242e80SGary R Hook 	/* Support for the CCP DMA capabilities
37958ea8abfSGary R Hook 	 */
38058ea8abfSGary R Hook 	struct dma_device dma_dev;
38158ea8abfSGary R Hook 	struct ccp_dma_chan *ccp_dma_chan;
38258ea8abfSGary R Hook 	struct kmem_cache *dma_cmd_cache;
38358ea8abfSGary R Hook 	struct kmem_cache *dma_desc_cache;
38458ea8abfSGary R Hook 
385fa242e80SGary R Hook 	/* A counter used to generate job-ids for cmds submitted to the CCP
38663b94509STom Lendacky 	 */
38763b94509STom Lendacky 	atomic_t current_id ____cacheline_aligned;
38863b94509STom Lendacky 
38958a690b7SGary R Hook 	/* The v3 CCP uses key storage blocks (SB) to maintain context for
39058a690b7SGary R Hook 	 * certain operations. To prevent multiple cmds from using the same
39158a690b7SGary R Hook 	 * SB range a command queue reserves an SB range for the duration of
39258a690b7SGary R Hook 	 * the cmd. Each queue, will however, reserve 2 SB blocks for
39358a690b7SGary R Hook 	 * operations that only require single SB entries (eg. AES context/iv
39458a690b7SGary R Hook 	 * and key) in order to avoid allocation contention.  This will reserve
39558a690b7SGary R Hook 	 * at most 10 SB entries, leaving 40 SB entries available for dynamic
39658a690b7SGary R Hook 	 * allocation.
39758a690b7SGary R Hook 	 *
39858a690b7SGary R Hook 	 * The v5 CCP Local Storage Block (LSB) is broken up into 8
39958a690b7SGary R Hook 	 * memrory ranges, each of which can be enabled for access by one
40058a690b7SGary R Hook 	 * or more queues. Device initialization takes this into account,
40158a690b7SGary R Hook 	 * and attempts to assign one region for exclusive use by each
40258a690b7SGary R Hook 	 * available queue; the rest are then aggregated as "public" use.
40358a690b7SGary R Hook 	 * If there are fewer regions than queues, all regions are shared
40458a690b7SGary R Hook 	 * amongst all queues.
40563b94509STom Lendacky 	 */
406956ee21aSGary R Hook 	struct mutex sb_mutex ____cacheline_aligned;
407956ee21aSGary R Hook 	DECLARE_BITMAP(sb, KSB_COUNT);
408956ee21aSGary R Hook 	wait_queue_head_t sb_queue;
409956ee21aSGary R Hook 	unsigned int sb_avail;
410956ee21aSGary R Hook 	unsigned int sb_count;
411956ee21aSGary R Hook 	u32 sb_start;
41263b94509STom Lendacky 
4134b394a23SGary R Hook 	/* Bitmap of shared LSBs, if any */
4144b394a23SGary R Hook 	DECLARE_BITMAP(lsbmap, SLSB_MAP_SIZE);
4154b394a23SGary R Hook 
41663b94509STom Lendacky 	/* Suspend support */
41763b94509STom Lendacky 	unsigned int suspending;
41863b94509STom Lendacky 	wait_queue_head_t suspend_queue;
419126ae9adSTom Lendacky 
420126ae9adSTom Lendacky 	/* DMA caching attribute support */
421126ae9adSTom Lendacky 	unsigned int axcache;
42263b94509STom Lendacky };
42363b94509STom Lendacky 
424ea0375afSGary R Hook enum ccp_memtype {
425ea0375afSGary R Hook 	CCP_MEMTYPE_SYSTEM = 0,
426956ee21aSGary R Hook 	CCP_MEMTYPE_SB,
427ea0375afSGary R Hook 	CCP_MEMTYPE_LOCAL,
428ea0375afSGary R Hook 	CCP_MEMTYPE__LAST,
429ea0375afSGary R Hook };
4304b394a23SGary R Hook #define	CCP_MEMTYPE_LSB	CCP_MEMTYPE_KSB
431ea0375afSGary R Hook 
4322d158391SGary R Hook 
433ea0375afSGary R Hook struct ccp_dma_info {
434ea0375afSGary R Hook 	dma_addr_t address;
435ea0375afSGary R Hook 	unsigned int offset;
436ea0375afSGary R Hook 	unsigned int length;
437ea0375afSGary R Hook 	enum dma_data_direction dir;
4382d158391SGary R Hook } __packed __aligned(4);
439ea0375afSGary R Hook 
440ea0375afSGary R Hook struct ccp_dm_workarea {
441ea0375afSGary R Hook 	struct device *dev;
442ea0375afSGary R Hook 	struct dma_pool *dma_pool;
443ea0375afSGary R Hook 
444ea0375afSGary R Hook 	u8 *address;
445ea0375afSGary R Hook 	struct ccp_dma_info dma;
4462d158391SGary R Hook 	unsigned int length;
447ea0375afSGary R Hook };
448ea0375afSGary R Hook 
449ea0375afSGary R Hook struct ccp_sg_workarea {
450ea0375afSGary R Hook 	struct scatterlist *sg;
451ea0375afSGary R Hook 	int nents;
4522d158391SGary R Hook 	unsigned int sg_used;
453ea0375afSGary R Hook 
454ea0375afSGary R Hook 	struct scatterlist *dma_sg;
455ea0375afSGary R Hook 	struct device *dma_dev;
456ea0375afSGary R Hook 	unsigned int dma_count;
457ea0375afSGary R Hook 	enum dma_data_direction dma_dir;
458ea0375afSGary R Hook 
459ea0375afSGary R Hook 	u64 bytes_left;
460ea0375afSGary R Hook };
461ea0375afSGary R Hook 
462ea0375afSGary R Hook struct ccp_data {
463ea0375afSGary R Hook 	struct ccp_sg_workarea sg_wa;
464ea0375afSGary R Hook 	struct ccp_dm_workarea dm_wa;
465ea0375afSGary R Hook };
466ea0375afSGary R Hook 
467ea0375afSGary R Hook struct ccp_mem {
468ea0375afSGary R Hook 	enum ccp_memtype type;
469ea0375afSGary R Hook 	union {
470ea0375afSGary R Hook 		struct ccp_dma_info dma;
471956ee21aSGary R Hook 		u32 sb;
472ea0375afSGary R Hook 	} u;
473ea0375afSGary R Hook };
474ea0375afSGary R Hook 
475ea0375afSGary R Hook struct ccp_aes_op {
476ea0375afSGary R Hook 	enum ccp_aes_type type;
477ea0375afSGary R Hook 	enum ccp_aes_mode mode;
478ea0375afSGary R Hook 	enum ccp_aes_action action;
479f7cc02b3SGary R Hook 	unsigned int size;
480ea0375afSGary R Hook };
481ea0375afSGary R Hook 
482ea0375afSGary R Hook struct ccp_xts_aes_op {
483ea0375afSGary R Hook 	enum ccp_aes_action action;
484ea0375afSGary R Hook 	enum ccp_xts_aes_unit_size unit_size;
485ea0375afSGary R Hook };
486ea0375afSGary R Hook 
487990672d4SGary R Hook struct ccp_des3_op {
488990672d4SGary R Hook 	enum ccp_des3_type type;
489990672d4SGary R Hook 	enum ccp_des3_mode mode;
490990672d4SGary R Hook 	enum ccp_des3_action action;
491990672d4SGary R Hook };
492990672d4SGary R Hook 
493ea0375afSGary R Hook struct ccp_sha_op {
494ea0375afSGary R Hook 	enum ccp_sha_type type;
495ea0375afSGary R Hook 	u64 msg_bits;
496ea0375afSGary R Hook };
497ea0375afSGary R Hook 
498ea0375afSGary R Hook struct ccp_rsa_op {
499ea0375afSGary R Hook 	u32 mod_size;
500ea0375afSGary R Hook 	u32 input_len;
501ea0375afSGary R Hook };
502ea0375afSGary R Hook 
503ea0375afSGary R Hook struct ccp_passthru_op {
504ea0375afSGary R Hook 	enum ccp_passthru_bitwise bit_mod;
505ea0375afSGary R Hook 	enum ccp_passthru_byteswap byte_swap;
506ea0375afSGary R Hook };
507ea0375afSGary R Hook 
508ea0375afSGary R Hook struct ccp_ecc_op {
509ea0375afSGary R Hook 	enum ccp_ecc_function function;
510ea0375afSGary R Hook };
511ea0375afSGary R Hook 
512ea0375afSGary R Hook struct ccp_op {
513ea0375afSGary R Hook 	struct ccp_cmd_queue *cmd_q;
514ea0375afSGary R Hook 
515ea0375afSGary R Hook 	u32 jobid;
516ea0375afSGary R Hook 	u32 ioc;
517ea0375afSGary R Hook 	u32 soc;
518956ee21aSGary R Hook 	u32 sb_key;
519956ee21aSGary R Hook 	u32 sb_ctx;
520ea0375afSGary R Hook 	u32 init;
521ea0375afSGary R Hook 	u32 eom;
522ea0375afSGary R Hook 
523ea0375afSGary R Hook 	struct ccp_mem src;
524ea0375afSGary R Hook 	struct ccp_mem dst;
5254b394a23SGary R Hook 	struct ccp_mem exp;
526ea0375afSGary R Hook 
527ea0375afSGary R Hook 	union {
528ea0375afSGary R Hook 		struct ccp_aes_op aes;
529ea0375afSGary R Hook 		struct ccp_xts_aes_op xts;
530990672d4SGary R Hook 		struct ccp_des3_op des3;
531ea0375afSGary R Hook 		struct ccp_sha_op sha;
532ea0375afSGary R Hook 		struct ccp_rsa_op rsa;
533ea0375afSGary R Hook 		struct ccp_passthru_op passthru;
534ea0375afSGary R Hook 		struct ccp_ecc_op ecc;
535ea0375afSGary R Hook 	} u;
536ea0375afSGary R Hook };
537ea0375afSGary R Hook 
538ea0375afSGary R Hook static inline u32 ccp_addr_lo(struct ccp_dma_info *info)
539ea0375afSGary R Hook {
540ea0375afSGary R Hook 	return lower_32_bits(info->address + info->offset);
541ea0375afSGary R Hook }
542ea0375afSGary R Hook 
543ea0375afSGary R Hook static inline u32 ccp_addr_hi(struct ccp_dma_info *info)
544ea0375afSGary R Hook {
545ea0375afSGary R Hook 	return upper_32_bits(info->address + info->offset) & 0x0000ffff;
546ea0375afSGary R Hook }
547ea0375afSGary R Hook 
5484b394a23SGary R Hook /**
5494b394a23SGary R Hook  * descriptor for version 5 CPP commands
5504b394a23SGary R Hook  * 8 32-bit words:
5514b394a23SGary R Hook  * word 0: function; engine; control bits
5524b394a23SGary R Hook  * word 1: length of source data
5534b394a23SGary R Hook  * word 2: low 32 bits of source pointer
5544b394a23SGary R Hook  * word 3: upper 16 bits of source pointer; source memory type
5554b394a23SGary R Hook  * word 4: low 32 bits of destination pointer
5564b394a23SGary R Hook  * word 5: upper 16 bits of destination pointer; destination memory type
5574b394a23SGary R Hook  * word 6: low 32 bits of key pointer
5584b394a23SGary R Hook  * word 7: upper 16 bits of key pointer; key memory type
5594b394a23SGary R Hook  */
5604b394a23SGary R Hook struct dword0 {
561fdd2cf9dSGary R Hook 	unsigned int soc:1;
562fdd2cf9dSGary R Hook 	unsigned int ioc:1;
563fdd2cf9dSGary R Hook 	unsigned int rsvd1:1;
564fdd2cf9dSGary R Hook 	unsigned int init:1;
565fdd2cf9dSGary R Hook 	unsigned int eom:1;		/* AES/SHA only */
566fdd2cf9dSGary R Hook 	unsigned int function:15;
567fdd2cf9dSGary R Hook 	unsigned int engine:4;
568fdd2cf9dSGary R Hook 	unsigned int prot:1;
569fdd2cf9dSGary R Hook 	unsigned int rsvd2:7;
5704b394a23SGary R Hook };
5714b394a23SGary R Hook 
5724b394a23SGary R Hook struct dword3 {
573fdd2cf9dSGary R Hook 	unsigned int  src_hi:16;
574fdd2cf9dSGary R Hook 	unsigned int  src_mem:2;
575fdd2cf9dSGary R Hook 	unsigned int  lsb_cxt_id:8;
576fdd2cf9dSGary R Hook 	unsigned int  rsvd1:5;
577fdd2cf9dSGary R Hook 	unsigned int  fixed:1;
5784b394a23SGary R Hook };
5794b394a23SGary R Hook 
5804b394a23SGary R Hook union dword4 {
5814b394a23SGary R Hook 	__le32 dst_lo;		/* NON-SHA	*/
5824b394a23SGary R Hook 	__le32 sha_len_lo;	/* SHA		*/
5834b394a23SGary R Hook };
5844b394a23SGary R Hook 
5854b394a23SGary R Hook union dword5 {
5864b394a23SGary R Hook 	struct {
587fdd2cf9dSGary R Hook 		unsigned int  dst_hi:16;
588fdd2cf9dSGary R Hook 		unsigned int  dst_mem:2;
589fdd2cf9dSGary R Hook 		unsigned int  rsvd1:13;
590fdd2cf9dSGary R Hook 		unsigned int  fixed:1;
5914b394a23SGary R Hook 	} fields;
5924b394a23SGary R Hook 	__le32 sha_len_hi;
5934b394a23SGary R Hook };
5944b394a23SGary R Hook 
5954b394a23SGary R Hook struct dword7 {
596fdd2cf9dSGary R Hook 	unsigned int  key_hi:16;
597fdd2cf9dSGary R Hook 	unsigned int  key_mem:2;
598fdd2cf9dSGary R Hook 	unsigned int  rsvd1:14;
5994b394a23SGary R Hook };
6004b394a23SGary R Hook 
6014b394a23SGary R Hook struct ccp5_desc {
6024b394a23SGary R Hook 	struct dword0 dw0;
6034b394a23SGary R Hook 	__le32 length;
6044b394a23SGary R Hook 	__le32 src_lo;
6054b394a23SGary R Hook 	struct dword3 dw3;
6064b394a23SGary R Hook 	union dword4 dw4;
6074b394a23SGary R Hook 	union dword5 dw5;
6084b394a23SGary R Hook 	__le32 key_lo;
6094b394a23SGary R Hook 	struct dword7 dw7;
6104b394a23SGary R Hook };
6114b394a23SGary R Hook 
61263b94509STom Lendacky int ccp_pci_init(void);
61363b94509STom Lendacky void ccp_pci_exit(void);
61463b94509STom Lendacky 
615c4f4b325STom Lendacky int ccp_platform_init(void);
616c4f4b325STom Lendacky void ccp_platform_exit(void);
617c4f4b325STom Lendacky 
618ea0375afSGary R Hook void ccp_add_device(struct ccp_device *ccp);
619ea0375afSGary R Hook void ccp_del_device(struct ccp_device *ccp);
62063b94509STom Lendacky 
62181422badSGary R Hook extern void ccp_log_error(struct ccp_device *, int);
62281422badSGary R Hook 
623ea0375afSGary R Hook struct ccp_device *ccp_alloc_struct(struct device *dev);
624ea0375afSGary R Hook bool ccp_queues_suspended(struct ccp_device *ccp);
625ea0375afSGary R Hook int ccp_cmd_queue_thread(void *data);
6268256e683SGary R Hook int ccp_trng_read(struct hwrng *rng, void *data, size_t max, bool wait);
62763b94509STom Lendacky 
62863b94509STom Lendacky int ccp_run_cmd(struct ccp_cmd_queue *cmd_q, struct ccp_cmd *cmd);
62963b94509STom Lendacky 
630084935b2SGary R Hook int ccp_register_rng(struct ccp_device *ccp);
631084935b2SGary R Hook void ccp_unregister_rng(struct ccp_device *ccp);
63258ea8abfSGary R Hook int ccp_dmaengine_register(struct ccp_device *ccp);
63358ea8abfSGary R Hook void ccp_dmaengine_unregister(struct ccp_device *ccp);
63458ea8abfSGary R Hook 
63558a690b7SGary R Hook /* Structure for computation functions that are device-specific */
63658a690b7SGary R Hook struct ccp_actions {
63758a690b7SGary R Hook 	int (*aes)(struct ccp_op *);
63858a690b7SGary R Hook 	int (*xts_aes)(struct ccp_op *);
639990672d4SGary R Hook 	int (*des3)(struct ccp_op *);
64058a690b7SGary R Hook 	int (*sha)(struct ccp_op *);
64158a690b7SGary R Hook 	int (*rsa)(struct ccp_op *);
64258a690b7SGary R Hook 	int (*passthru)(struct ccp_op *);
64358a690b7SGary R Hook 	int (*ecc)(struct ccp_op *);
64458a690b7SGary R Hook 	u32 (*sballoc)(struct ccp_cmd_queue *, unsigned int);
645990672d4SGary R Hook 	void (*sbfree)(struct ccp_cmd_queue *, unsigned int, unsigned int);
646bb4e89b3SGary R Hook 	unsigned int (*get_free_slots)(struct ccp_cmd_queue *);
64758a690b7SGary R Hook 	int (*init)(struct ccp_device *);
64858a690b7SGary R Hook 	void (*destroy)(struct ccp_device *);
64958a690b7SGary R Hook 	irqreturn_t (*irqhandler)(int, void *);
65058a690b7SGary R Hook };
65158a690b7SGary R Hook 
65258a690b7SGary R Hook /* Structure to hold CCP version-specific values */
65358a690b7SGary R Hook struct ccp_vdata {
6544b394a23SGary R Hook 	const unsigned int version;
655efc989fcSGary R Hook 	const unsigned int dma_chan_attr;
6564b394a23SGary R Hook 	void (*setup)(struct ccp_device *);
65758a690b7SGary R Hook 	const struct ccp_actions *perform;
65858a690b7SGary R Hook 	const unsigned int bar;
65958a690b7SGary R Hook 	const unsigned int offset;
66058a690b7SGary R Hook };
66158a690b7SGary R Hook 
6629ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv3;
6639ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv5a;
6649ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv5b;
66558a690b7SGary R Hook 
66663b94509STom Lendacky #endif
667