xref: /openbmc/linux/drivers/crypto/ccp/ccp-dev.h (revision efc989fce8703914bac091dcc4b8ff7a72ccf987)
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
1124b394a23SGary R Hook #define ALL_INTERRUPTS			(INT_COMPLETION| \
1134b394a23SGary R Hook 					 INT_ERROR| \
1144b394a23SGary R Hook 					 INT_QUEUE_STOPPED)
1154b394a23SGary R Hook 
1164b394a23SGary R Hook #define LSB_REGION_WIDTH		5
1174b394a23SGary R Hook #define MAX_LSB_CNT			8
1184b394a23SGary R Hook 
1194b394a23SGary R Hook #define LSB_SIZE			16
1204b394a23SGary R Hook #define LSB_ITEM_SIZE			32
1214b394a23SGary R Hook #define PLSB_MAP_SIZE			(LSB_SIZE)
1224b394a23SGary R Hook #define SLSB_MAP_SIZE			(MAX_LSB_CNT * LSB_SIZE)
1234b394a23SGary R Hook 
1244b394a23SGary R Hook #define LSB_ENTRY_NUMBER(LSB_ADDR)	(LSB_ADDR / LSB_ITEM_SIZE)
1254b394a23SGary R Hook 
1264b394a23SGary R Hook /* ------------------------ CCP Version 3 Specifics ------------------------ */
12763b94509STom Lendacky #define REQ0_WAIT_FOR_WRITE		0x00000004
12863b94509STom Lendacky #define REQ0_INT_ON_COMPLETE		0x00000002
12963b94509STom Lendacky #define REQ0_STOP_ON_COMPLETE		0x00000001
13063b94509STom Lendacky 
13163b94509STom Lendacky #define REQ0_CMD_Q_SHIFT		9
13263b94509STom Lendacky #define REQ0_JOBID_SHIFT		3
13363b94509STom Lendacky 
13463b94509STom Lendacky /****** REQ1 Related Values ******/
13563b94509STom Lendacky #define REQ1_PROTECT_SHIFT		27
13663b94509STom Lendacky #define REQ1_ENGINE_SHIFT		23
13763b94509STom Lendacky #define REQ1_KEY_KSB_SHIFT		2
13863b94509STom Lendacky 
13963b94509STom Lendacky #define REQ1_EOM			0x00000002
14063b94509STom Lendacky #define REQ1_INIT			0x00000001
14163b94509STom Lendacky 
14263b94509STom Lendacky /* AES Related Values */
14363b94509STom Lendacky #define REQ1_AES_TYPE_SHIFT		21
14463b94509STom Lendacky #define REQ1_AES_MODE_SHIFT		18
14563b94509STom Lendacky #define REQ1_AES_ACTION_SHIFT		17
14663b94509STom Lendacky #define REQ1_AES_CFB_SIZE_SHIFT		10
14763b94509STom Lendacky 
14863b94509STom Lendacky /* XTS-AES Related Values */
14963b94509STom Lendacky #define REQ1_XTS_AES_SIZE_SHIFT		10
15063b94509STom Lendacky 
15163b94509STom Lendacky /* SHA Related Values */
15263b94509STom Lendacky #define REQ1_SHA_TYPE_SHIFT		21
15363b94509STom Lendacky 
15463b94509STom Lendacky /* RSA Related Values */
15563b94509STom Lendacky #define REQ1_RSA_MOD_SIZE_SHIFT		10
15663b94509STom Lendacky 
15763b94509STom Lendacky /* Pass-Through Related Values */
15863b94509STom Lendacky #define REQ1_PT_BW_SHIFT		12
15963b94509STom Lendacky #define REQ1_PT_BS_SHIFT		10
16063b94509STom Lendacky 
16163b94509STom Lendacky /* ECC Related Values */
16263b94509STom Lendacky #define REQ1_ECC_AFFINE_CONVERT		0x00200000
16363b94509STom Lendacky #define REQ1_ECC_FUNCTION_SHIFT		18
16463b94509STom Lendacky 
16563b94509STom Lendacky /****** REQ4 Related Values ******/
16663b94509STom Lendacky #define REQ4_KSB_SHIFT			18
16763b94509STom Lendacky #define REQ4_MEMTYPE_SHIFT		16
16863b94509STom Lendacky 
16963b94509STom Lendacky /****** REQ6 Related Values ******/
17063b94509STom Lendacky #define REQ6_MEMTYPE_SHIFT		16
17163b94509STom Lendacky 
17263b94509STom Lendacky /****** Key Storage Block ******/
17363b94509STom Lendacky #define KSB_START			77
17463b94509STom Lendacky #define KSB_END				127
17563b94509STom Lendacky #define KSB_COUNT			(KSB_END - KSB_START + 1)
176956ee21aSGary R Hook #define CCP_SB_BITS			256
17763b94509STom Lendacky 
17863b94509STom Lendacky #define CCP_JOBID_MASK			0x0000003f
17963b94509STom Lendacky 
1804b394a23SGary R Hook /* ------------------------ General CCP Defines ------------------------ */
1814b394a23SGary R Hook 
182*efc989fcSGary R Hook #define	CCP_DMA_DFLT			0x0
183*efc989fcSGary R Hook #define	CCP_DMA_PRIV			0x1
184*efc989fcSGary R Hook #define	CCP_DMA_PUB			0x2
185*efc989fcSGary R Hook 
18663b94509STom Lendacky #define CCP_DMAPOOL_MAX_SIZE		64
1878db88467STom Lendacky #define CCP_DMAPOOL_ALIGN		BIT(5)
18863b94509STom Lendacky 
18963b94509STom Lendacky #define CCP_REVERSE_BUF_SIZE		64
19063b94509STom Lendacky 
191956ee21aSGary R Hook #define CCP_AES_KEY_SB_COUNT		1
192956ee21aSGary R Hook #define CCP_AES_CTX_SB_COUNT		1
19363b94509STom Lendacky 
194956ee21aSGary R Hook #define CCP_XTS_AES_KEY_SB_COUNT	1
195956ee21aSGary R Hook #define CCP_XTS_AES_CTX_SB_COUNT	1
19663b94509STom Lendacky 
197956ee21aSGary R Hook #define CCP_SHA_SB_COUNT		1
19863b94509STom Lendacky 
19963b94509STom Lendacky #define CCP_RSA_MAX_WIDTH		4096
20063b94509STom Lendacky 
20163b94509STom Lendacky #define CCP_PASSTHRU_BLOCKSIZE		256
20263b94509STom Lendacky #define CCP_PASSTHRU_MASKSIZE		32
203956ee21aSGary R Hook #define CCP_PASSTHRU_SB_COUNT		1
20463b94509STom Lendacky 
20563b94509STom Lendacky #define CCP_ECC_MODULUS_BYTES		48      /* 384-bits */
20663b94509STom Lendacky #define CCP_ECC_MAX_OPERANDS		6
20763b94509STom Lendacky #define CCP_ECC_MAX_OUTPUTS		3
20863b94509STom Lendacky #define CCP_ECC_SRC_BUF_SIZE		448
20963b94509STom Lendacky #define CCP_ECC_DST_BUF_SIZE		192
21063b94509STom Lendacky #define CCP_ECC_OPERAND_SIZE		64
21163b94509STom Lendacky #define CCP_ECC_OUTPUT_SIZE		64
21263b94509STom Lendacky #define CCP_ECC_RESULT_OFFSET		60
21363b94509STom Lendacky #define CCP_ECC_RESULT_SUCCESS		0x0001
21463b94509STom Lendacky 
215956ee21aSGary R Hook #define CCP_SB_BYTES			32
216956ee21aSGary R Hook 
217ea0375afSGary R Hook struct ccp_op;
21863b94509STom Lendacky struct ccp_device;
21963b94509STom Lendacky struct ccp_cmd;
2204b394a23SGary R Hook struct ccp_fns;
22163b94509STom Lendacky 
22258ea8abfSGary R Hook struct ccp_dma_cmd {
22358ea8abfSGary R Hook 	struct list_head entry;
22458ea8abfSGary R Hook 
22558ea8abfSGary R Hook 	struct ccp_cmd ccp_cmd;
22658ea8abfSGary R Hook };
22758ea8abfSGary R Hook 
22858ea8abfSGary R Hook struct ccp_dma_desc {
22958ea8abfSGary R Hook 	struct list_head entry;
23058ea8abfSGary R Hook 
23158ea8abfSGary R Hook 	struct ccp_device *ccp;
23258ea8abfSGary R Hook 
23358ea8abfSGary R Hook 	struct list_head pending;
23458ea8abfSGary R Hook 	struct list_head active;
23558ea8abfSGary R Hook 
23658ea8abfSGary R Hook 	enum dma_status status;
23758ea8abfSGary R Hook 	struct dma_async_tx_descriptor tx_desc;
23858ea8abfSGary R Hook 	size_t len;
23958ea8abfSGary R Hook };
24058ea8abfSGary R Hook 
24158ea8abfSGary R Hook struct ccp_dma_chan {
24258ea8abfSGary R Hook 	struct ccp_device *ccp;
24358ea8abfSGary R Hook 
24458ea8abfSGary R Hook 	spinlock_t lock;
245e5da5c56SGary R Hook 	struct list_head created;
24658ea8abfSGary R Hook 	struct list_head pending;
24758ea8abfSGary R Hook 	struct list_head active;
24858ea8abfSGary R Hook 	struct list_head complete;
24958ea8abfSGary R Hook 
25058ea8abfSGary R Hook 	struct tasklet_struct cleanup_tasklet;
25158ea8abfSGary R Hook 
25258ea8abfSGary R Hook 	enum dma_status status;
25358ea8abfSGary R Hook 	struct dma_chan dma_chan;
25458ea8abfSGary R Hook };
25558ea8abfSGary R Hook 
25663b94509STom Lendacky struct ccp_cmd_queue {
25763b94509STom Lendacky 	struct ccp_device *ccp;
25863b94509STom Lendacky 
25963b94509STom Lendacky 	/* Queue identifier */
26063b94509STom Lendacky 	u32 id;
26163b94509STom Lendacky 
26263b94509STom Lendacky 	/* Queue dma pool */
26363b94509STom Lendacky 	struct dma_pool *dma_pool;
26463b94509STom Lendacky 
2654b394a23SGary R Hook 	/* Queue base address (not neccessarily aligned)*/
2664b394a23SGary R Hook 	struct ccp5_desc *qbase;
2674b394a23SGary R Hook 
2684b394a23SGary R Hook 	/* Aligned queue start address (per requirement) */
2694b394a23SGary R Hook 	struct mutex q_mutex ____cacheline_aligned;
2704b394a23SGary R Hook 	unsigned int qidx;
2714b394a23SGary R Hook 
2724b394a23SGary R Hook 	/* Version 5 has different requirements for queue memory */
2734b394a23SGary R Hook 	unsigned int qsize;
2744b394a23SGary R Hook 	dma_addr_t qbase_dma;
2754b394a23SGary R Hook 	dma_addr_t qdma_tail;
2764b394a23SGary R Hook 
277956ee21aSGary R Hook 	/* Per-queue reserved storage block(s) */
278956ee21aSGary R Hook 	u32 sb_key;
279956ee21aSGary R Hook 	u32 sb_ctx;
28063b94509STom Lendacky 
2814b394a23SGary R Hook 	/* Bitmap of LSBs that can be accessed by this queue */
2824b394a23SGary R Hook 	DECLARE_BITMAP(lsbmask, MAX_LSB_CNT);
2834b394a23SGary R Hook 	/* Private LSB that is assigned to this queue, or -1 if none.
2844b394a23SGary R Hook 	 * Bitmap for my private LSB, unused otherwise
2854b394a23SGary R Hook 	 */
2863cf79968SGary R Hook 	int lsb;
2874b394a23SGary R Hook 	DECLARE_BITMAP(lsbmap, PLSB_MAP_SIZE);
2884b394a23SGary R Hook 
28963b94509STom Lendacky 	/* Queue processing thread */
29063b94509STom Lendacky 	struct task_struct *kthread;
29163b94509STom Lendacky 	unsigned int active;
29263b94509STom Lendacky 	unsigned int suspended;
29363b94509STom Lendacky 
29463b94509STom Lendacky 	/* Number of free command slots available */
29563b94509STom Lendacky 	unsigned int free_slots;
29663b94509STom Lendacky 
29763b94509STom Lendacky 	/* Interrupt masks */
29863b94509STom Lendacky 	u32 int_ok;
29963b94509STom Lendacky 	u32 int_err;
30063b94509STom Lendacky 
30163b94509STom Lendacky 	/* Register addresses for queue */
3024b394a23SGary R Hook 	void __iomem *reg_control;
3034b394a23SGary R Hook 	void __iomem *reg_tail_lo;
3044b394a23SGary R Hook 	void __iomem *reg_head_lo;
3054b394a23SGary R Hook 	void __iomem *reg_int_enable;
3064b394a23SGary R Hook 	void __iomem *reg_interrupt_status;
30763b94509STom Lendacky 	void __iomem *reg_status;
30863b94509STom Lendacky 	void __iomem *reg_int_status;
3094b394a23SGary R Hook 	void __iomem *reg_dma_status;
3104b394a23SGary R Hook 	void __iomem *reg_dma_read_status;
3114b394a23SGary R Hook 	void __iomem *reg_dma_write_status;
3124b394a23SGary R Hook 	u32 qcontrol; /* Cached control register */
31363b94509STom Lendacky 
31463b94509STom Lendacky 	/* Status values from job */
31563b94509STom Lendacky 	u32 int_status;
31663b94509STom Lendacky 	u32 q_status;
31763b94509STom Lendacky 	u32 q_int_status;
31863b94509STom Lendacky 	u32 cmd_error;
31963b94509STom Lendacky 
32063b94509STom Lendacky 	/* Interrupt wait queue */
32163b94509STom Lendacky 	wait_queue_head_t int_queue;
32263b94509STom Lendacky 	unsigned int int_rcvd;
32363b94509STom Lendacky } ____cacheline_aligned;
32463b94509STom Lendacky 
32563b94509STom Lendacky struct ccp_device {
326553d2374SGary R Hook 	struct list_head entry;
327553d2374SGary R Hook 
328c7019c4dSGary R Hook 	struct ccp_vdata *vdata;
329553d2374SGary R Hook 	unsigned int ord;
330553d2374SGary R Hook 	char name[MAX_CCP_NAME_LEN];
331553d2374SGary R Hook 	char rngname[MAX_CCP_NAME_LEN];
332553d2374SGary R Hook 
33363b94509STom Lendacky 	struct device *dev;
33463b94509STom Lendacky 
335fa242e80SGary R Hook 	/* Bus specific device information
33663b94509STom Lendacky 	 */
33763b94509STom Lendacky 	void *dev_specific;
33863b94509STom Lendacky 	int (*get_irq)(struct ccp_device *ccp);
33963b94509STom Lendacky 	void (*free_irq)(struct ccp_device *ccp);
3403d77565bSTom Lendacky 	unsigned int irq;
34163b94509STom Lendacky 
342fa242e80SGary R Hook 	/* I/O area used for device communication. The register mapping
34363b94509STom Lendacky 	 * starts at an offset into the mapped bar.
34463b94509STom Lendacky 	 *   The CMD_REQx registers and the Delete_Cmd_Queue_Job register
34563b94509STom Lendacky 	 *   need to be protected while a command queue thread is accessing
34663b94509STom Lendacky 	 *   them.
34763b94509STom Lendacky 	 */
34863b94509STom Lendacky 	struct mutex req_mutex ____cacheline_aligned;
34963b94509STom Lendacky 	void __iomem *io_map;
35063b94509STom Lendacky 	void __iomem *io_regs;
35163b94509STom Lendacky 
352fa242e80SGary R Hook 	/* Master lists that all cmds are queued on. Because there can be
35363b94509STom Lendacky 	 * more than one CCP command queue that can process a cmd a separate
35463b94509STom Lendacky 	 * backlog list is neeeded so that the backlog completion call
35563b94509STom Lendacky 	 * completes before the cmd is available for execution.
35663b94509STom Lendacky 	 */
35763b94509STom Lendacky 	spinlock_t cmd_lock ____cacheline_aligned;
35863b94509STom Lendacky 	unsigned int cmd_count;
35963b94509STom Lendacky 	struct list_head cmd;
36063b94509STom Lendacky 	struct list_head backlog;
36163b94509STom Lendacky 
362fa242e80SGary R Hook 	/* The command queues. These represent the queues available on the
36363b94509STom Lendacky 	 * CCP that are available for processing cmds
36463b94509STom Lendacky 	 */
36563b94509STom Lendacky 	struct ccp_cmd_queue cmd_q[MAX_HW_QUEUES];
36663b94509STom Lendacky 	unsigned int cmd_q_count;
36763b94509STom Lendacky 
368fa242e80SGary R Hook 	/* Support for the CCP True RNG
36963b94509STom Lendacky 	 */
37063b94509STom Lendacky 	struct hwrng hwrng;
37163b94509STom Lendacky 	unsigned int hwrng_retries;
37263b94509STom Lendacky 
373fa242e80SGary R Hook 	/* Support for the CCP DMA capabilities
37458ea8abfSGary R Hook 	 */
37558ea8abfSGary R Hook 	struct dma_device dma_dev;
37658ea8abfSGary R Hook 	struct ccp_dma_chan *ccp_dma_chan;
37758ea8abfSGary R Hook 	struct kmem_cache *dma_cmd_cache;
37858ea8abfSGary R Hook 	struct kmem_cache *dma_desc_cache;
37958ea8abfSGary R Hook 
380fa242e80SGary R Hook 	/* A counter used to generate job-ids for cmds submitted to the CCP
38163b94509STom Lendacky 	 */
38263b94509STom Lendacky 	atomic_t current_id ____cacheline_aligned;
38363b94509STom Lendacky 
38458a690b7SGary R Hook 	/* The v3 CCP uses key storage blocks (SB) to maintain context for
38558a690b7SGary R Hook 	 * certain operations. To prevent multiple cmds from using the same
38658a690b7SGary R Hook 	 * SB range a command queue reserves an SB range for the duration of
38758a690b7SGary R Hook 	 * the cmd. Each queue, will however, reserve 2 SB blocks for
38858a690b7SGary R Hook 	 * operations that only require single SB entries (eg. AES context/iv
38958a690b7SGary R Hook 	 * and key) in order to avoid allocation contention.  This will reserve
39058a690b7SGary R Hook 	 * at most 10 SB entries, leaving 40 SB entries available for dynamic
39158a690b7SGary R Hook 	 * allocation.
39258a690b7SGary R Hook 	 *
39358a690b7SGary R Hook 	 * The v5 CCP Local Storage Block (LSB) is broken up into 8
39458a690b7SGary R Hook 	 * memrory ranges, each of which can be enabled for access by one
39558a690b7SGary R Hook 	 * or more queues. Device initialization takes this into account,
39658a690b7SGary R Hook 	 * and attempts to assign one region for exclusive use by each
39758a690b7SGary R Hook 	 * available queue; the rest are then aggregated as "public" use.
39858a690b7SGary R Hook 	 * If there are fewer regions than queues, all regions are shared
39958a690b7SGary R Hook 	 * amongst all queues.
40063b94509STom Lendacky 	 */
401956ee21aSGary R Hook 	struct mutex sb_mutex ____cacheline_aligned;
402956ee21aSGary R Hook 	DECLARE_BITMAP(sb, KSB_COUNT);
403956ee21aSGary R Hook 	wait_queue_head_t sb_queue;
404956ee21aSGary R Hook 	unsigned int sb_avail;
405956ee21aSGary R Hook 	unsigned int sb_count;
406956ee21aSGary R Hook 	u32 sb_start;
40763b94509STom Lendacky 
4084b394a23SGary R Hook 	/* Bitmap of shared LSBs, if any */
4094b394a23SGary R Hook 	DECLARE_BITMAP(lsbmap, SLSB_MAP_SIZE);
4104b394a23SGary R Hook 
41163b94509STom Lendacky 	/* Suspend support */
41263b94509STom Lendacky 	unsigned int suspending;
41363b94509STom Lendacky 	wait_queue_head_t suspend_queue;
414126ae9adSTom Lendacky 
415126ae9adSTom Lendacky 	/* DMA caching attribute support */
416126ae9adSTom Lendacky 	unsigned int axcache;
41763b94509STom Lendacky };
41863b94509STom Lendacky 
419ea0375afSGary R Hook enum ccp_memtype {
420ea0375afSGary R Hook 	CCP_MEMTYPE_SYSTEM = 0,
421956ee21aSGary R Hook 	CCP_MEMTYPE_SB,
422ea0375afSGary R Hook 	CCP_MEMTYPE_LOCAL,
423ea0375afSGary R Hook 	CCP_MEMTYPE__LAST,
424ea0375afSGary R Hook };
4254b394a23SGary R Hook #define	CCP_MEMTYPE_LSB	CCP_MEMTYPE_KSB
426ea0375afSGary R Hook 
427ea0375afSGary R Hook struct ccp_dma_info {
428ea0375afSGary R Hook 	dma_addr_t address;
429ea0375afSGary R Hook 	unsigned int offset;
430ea0375afSGary R Hook 	unsigned int length;
431ea0375afSGary R Hook 	enum dma_data_direction dir;
432ea0375afSGary R Hook };
433ea0375afSGary R Hook 
434ea0375afSGary R Hook struct ccp_dm_workarea {
435ea0375afSGary R Hook 	struct device *dev;
436ea0375afSGary R Hook 	struct dma_pool *dma_pool;
437ea0375afSGary R Hook 	unsigned int length;
438ea0375afSGary R Hook 
439ea0375afSGary R Hook 	u8 *address;
440ea0375afSGary R Hook 	struct ccp_dma_info dma;
441ea0375afSGary R Hook };
442ea0375afSGary R Hook 
443ea0375afSGary R Hook struct ccp_sg_workarea {
444ea0375afSGary R Hook 	struct scatterlist *sg;
445ea0375afSGary R Hook 	int nents;
446ea0375afSGary R Hook 
447ea0375afSGary R Hook 	struct scatterlist *dma_sg;
448ea0375afSGary R Hook 	struct device *dma_dev;
449ea0375afSGary R Hook 	unsigned int dma_count;
450ea0375afSGary R Hook 	enum dma_data_direction dma_dir;
451ea0375afSGary R Hook 
452ea0375afSGary R Hook 	unsigned int sg_used;
453ea0375afSGary R Hook 
454ea0375afSGary R Hook 	u64 bytes_left;
455ea0375afSGary R Hook };
456ea0375afSGary R Hook 
457ea0375afSGary R Hook struct ccp_data {
458ea0375afSGary R Hook 	struct ccp_sg_workarea sg_wa;
459ea0375afSGary R Hook 	struct ccp_dm_workarea dm_wa;
460ea0375afSGary R Hook };
461ea0375afSGary R Hook 
462ea0375afSGary R Hook struct ccp_mem {
463ea0375afSGary R Hook 	enum ccp_memtype type;
464ea0375afSGary R Hook 	union {
465ea0375afSGary R Hook 		struct ccp_dma_info dma;
466956ee21aSGary R Hook 		u32 sb;
467ea0375afSGary R Hook 	} u;
468ea0375afSGary R Hook };
469ea0375afSGary R Hook 
470ea0375afSGary R Hook struct ccp_aes_op {
471ea0375afSGary R Hook 	enum ccp_aes_type type;
472ea0375afSGary R Hook 	enum ccp_aes_mode mode;
473ea0375afSGary R Hook 	enum ccp_aes_action action;
474f7cc02b3SGary R Hook 	unsigned int size;
475ea0375afSGary R Hook };
476ea0375afSGary R Hook 
477ea0375afSGary R Hook struct ccp_xts_aes_op {
478ea0375afSGary R Hook 	enum ccp_aes_action action;
479ea0375afSGary R Hook 	enum ccp_xts_aes_unit_size unit_size;
480ea0375afSGary R Hook };
481ea0375afSGary R Hook 
482ea0375afSGary R Hook struct ccp_sha_op {
483ea0375afSGary R Hook 	enum ccp_sha_type type;
484ea0375afSGary R Hook 	u64 msg_bits;
485ea0375afSGary R Hook };
486ea0375afSGary R Hook 
487ea0375afSGary R Hook struct ccp_rsa_op {
488ea0375afSGary R Hook 	u32 mod_size;
489ea0375afSGary R Hook 	u32 input_len;
490ea0375afSGary R Hook };
491ea0375afSGary R Hook 
492ea0375afSGary R Hook struct ccp_passthru_op {
493ea0375afSGary R Hook 	enum ccp_passthru_bitwise bit_mod;
494ea0375afSGary R Hook 	enum ccp_passthru_byteswap byte_swap;
495ea0375afSGary R Hook };
496ea0375afSGary R Hook 
497ea0375afSGary R Hook struct ccp_ecc_op {
498ea0375afSGary R Hook 	enum ccp_ecc_function function;
499ea0375afSGary R Hook };
500ea0375afSGary R Hook 
501ea0375afSGary R Hook struct ccp_op {
502ea0375afSGary R Hook 	struct ccp_cmd_queue *cmd_q;
503ea0375afSGary R Hook 
504ea0375afSGary R Hook 	u32 jobid;
505ea0375afSGary R Hook 	u32 ioc;
506ea0375afSGary R Hook 	u32 soc;
507956ee21aSGary R Hook 	u32 sb_key;
508956ee21aSGary R Hook 	u32 sb_ctx;
509ea0375afSGary R Hook 	u32 init;
510ea0375afSGary R Hook 	u32 eom;
511ea0375afSGary R Hook 
512ea0375afSGary R Hook 	struct ccp_mem src;
513ea0375afSGary R Hook 	struct ccp_mem dst;
5144b394a23SGary R Hook 	struct ccp_mem exp;
515ea0375afSGary R Hook 
516ea0375afSGary R Hook 	union {
517ea0375afSGary R Hook 		struct ccp_aes_op aes;
518ea0375afSGary R Hook 		struct ccp_xts_aes_op xts;
519ea0375afSGary R Hook 		struct ccp_sha_op sha;
520ea0375afSGary R Hook 		struct ccp_rsa_op rsa;
521ea0375afSGary R Hook 		struct ccp_passthru_op passthru;
522ea0375afSGary R Hook 		struct ccp_ecc_op ecc;
523ea0375afSGary R Hook 	} u;
524ea0375afSGary R Hook };
525ea0375afSGary R Hook 
526ea0375afSGary R Hook static inline u32 ccp_addr_lo(struct ccp_dma_info *info)
527ea0375afSGary R Hook {
528ea0375afSGary R Hook 	return lower_32_bits(info->address + info->offset);
529ea0375afSGary R Hook }
530ea0375afSGary R Hook 
531ea0375afSGary R Hook static inline u32 ccp_addr_hi(struct ccp_dma_info *info)
532ea0375afSGary R Hook {
533ea0375afSGary R Hook 	return upper_32_bits(info->address + info->offset) & 0x0000ffff;
534ea0375afSGary R Hook }
535ea0375afSGary R Hook 
5364b394a23SGary R Hook /**
5374b394a23SGary R Hook  * descriptor for version 5 CPP commands
5384b394a23SGary R Hook  * 8 32-bit words:
5394b394a23SGary R Hook  * word 0: function; engine; control bits
5404b394a23SGary R Hook  * word 1: length of source data
5414b394a23SGary R Hook  * word 2: low 32 bits of source pointer
5424b394a23SGary R Hook  * word 3: upper 16 bits of source pointer; source memory type
5434b394a23SGary R Hook  * word 4: low 32 bits of destination pointer
5444b394a23SGary R Hook  * word 5: upper 16 bits of destination pointer; destination memory type
5454b394a23SGary R Hook  * word 6: low 32 bits of key pointer
5464b394a23SGary R Hook  * word 7: upper 16 bits of key pointer; key memory type
5474b394a23SGary R Hook  */
5484b394a23SGary R Hook struct dword0 {
549fdd2cf9dSGary R Hook 	unsigned int soc:1;
550fdd2cf9dSGary R Hook 	unsigned int ioc:1;
551fdd2cf9dSGary R Hook 	unsigned int rsvd1:1;
552fdd2cf9dSGary R Hook 	unsigned int init:1;
553fdd2cf9dSGary R Hook 	unsigned int eom:1;		/* AES/SHA only */
554fdd2cf9dSGary R Hook 	unsigned int function:15;
555fdd2cf9dSGary R Hook 	unsigned int engine:4;
556fdd2cf9dSGary R Hook 	unsigned int prot:1;
557fdd2cf9dSGary R Hook 	unsigned int rsvd2:7;
5584b394a23SGary R Hook };
5594b394a23SGary R Hook 
5604b394a23SGary R Hook struct dword3 {
561fdd2cf9dSGary R Hook 	unsigned int  src_hi:16;
562fdd2cf9dSGary R Hook 	unsigned int  src_mem:2;
563fdd2cf9dSGary R Hook 	unsigned int  lsb_cxt_id:8;
564fdd2cf9dSGary R Hook 	unsigned int  rsvd1:5;
565fdd2cf9dSGary R Hook 	unsigned int  fixed:1;
5664b394a23SGary R Hook };
5674b394a23SGary R Hook 
5684b394a23SGary R Hook union dword4 {
5694b394a23SGary R Hook 	__le32 dst_lo;		/* NON-SHA	*/
5704b394a23SGary R Hook 	__le32 sha_len_lo;	/* SHA		*/
5714b394a23SGary R Hook };
5724b394a23SGary R Hook 
5734b394a23SGary R Hook union dword5 {
5744b394a23SGary R Hook 	struct {
575fdd2cf9dSGary R Hook 		unsigned int  dst_hi:16;
576fdd2cf9dSGary R Hook 		unsigned int  dst_mem:2;
577fdd2cf9dSGary R Hook 		unsigned int  rsvd1:13;
578fdd2cf9dSGary R Hook 		unsigned int  fixed:1;
5794b394a23SGary R Hook 	} fields;
5804b394a23SGary R Hook 	__le32 sha_len_hi;
5814b394a23SGary R Hook };
5824b394a23SGary R Hook 
5834b394a23SGary R Hook struct dword7 {
584fdd2cf9dSGary R Hook 	unsigned int  key_hi:16;
585fdd2cf9dSGary R Hook 	unsigned int  key_mem:2;
586fdd2cf9dSGary R Hook 	unsigned int  rsvd1:14;
5874b394a23SGary R Hook };
5884b394a23SGary R Hook 
5894b394a23SGary R Hook struct ccp5_desc {
5904b394a23SGary R Hook 	struct dword0 dw0;
5914b394a23SGary R Hook 	__le32 length;
5924b394a23SGary R Hook 	__le32 src_lo;
5934b394a23SGary R Hook 	struct dword3 dw3;
5944b394a23SGary R Hook 	union dword4 dw4;
5954b394a23SGary R Hook 	union dword5 dw5;
5964b394a23SGary R Hook 	__le32 key_lo;
5974b394a23SGary R Hook 	struct dword7 dw7;
5984b394a23SGary R Hook };
5994b394a23SGary R Hook 
60063b94509STom Lendacky int ccp_pci_init(void);
60163b94509STom Lendacky void ccp_pci_exit(void);
60263b94509STom Lendacky 
603c4f4b325STom Lendacky int ccp_platform_init(void);
604c4f4b325STom Lendacky void ccp_platform_exit(void);
605c4f4b325STom Lendacky 
606ea0375afSGary R Hook void ccp_add_device(struct ccp_device *ccp);
607ea0375afSGary R Hook void ccp_del_device(struct ccp_device *ccp);
60863b94509STom Lendacky 
60981422badSGary R Hook extern void ccp_log_error(struct ccp_device *, int);
61081422badSGary R Hook 
611ea0375afSGary R Hook struct ccp_device *ccp_alloc_struct(struct device *dev);
612ea0375afSGary R Hook bool ccp_queues_suspended(struct ccp_device *ccp);
613ea0375afSGary R Hook int ccp_cmd_queue_thread(void *data);
6148256e683SGary R Hook int ccp_trng_read(struct hwrng *rng, void *data, size_t max, bool wait);
61563b94509STom Lendacky 
61663b94509STom Lendacky int ccp_run_cmd(struct ccp_cmd_queue *cmd_q, struct ccp_cmd *cmd);
61763b94509STom Lendacky 
618084935b2SGary R Hook int ccp_register_rng(struct ccp_device *ccp);
619084935b2SGary R Hook void ccp_unregister_rng(struct ccp_device *ccp);
62058ea8abfSGary R Hook int ccp_dmaengine_register(struct ccp_device *ccp);
62158ea8abfSGary R Hook void ccp_dmaengine_unregister(struct ccp_device *ccp);
62258ea8abfSGary R Hook 
62358a690b7SGary R Hook /* Structure for computation functions that are device-specific */
62458a690b7SGary R Hook struct ccp_actions {
62558a690b7SGary R Hook 	int (*aes)(struct ccp_op *);
62658a690b7SGary R Hook 	int (*xts_aes)(struct ccp_op *);
62758a690b7SGary R Hook 	int (*sha)(struct ccp_op *);
62858a690b7SGary R Hook 	int (*rsa)(struct ccp_op *);
62958a690b7SGary R Hook 	int (*passthru)(struct ccp_op *);
63058a690b7SGary R Hook 	int (*ecc)(struct ccp_op *);
63158a690b7SGary R Hook 	u32 (*sballoc)(struct ccp_cmd_queue *, unsigned int);
63258a690b7SGary R Hook 	void (*sbfree)(struct ccp_cmd_queue *, unsigned int,
63358a690b7SGary R Hook 			       unsigned int);
634bb4e89b3SGary R Hook 	unsigned int (*get_free_slots)(struct ccp_cmd_queue *);
63558a690b7SGary R Hook 	int (*init)(struct ccp_device *);
63658a690b7SGary R Hook 	void (*destroy)(struct ccp_device *);
63758a690b7SGary R Hook 	irqreturn_t (*irqhandler)(int, void *);
63858a690b7SGary R Hook };
63958a690b7SGary R Hook 
64058a690b7SGary R Hook /* Structure to hold CCP version-specific values */
64158a690b7SGary R Hook struct ccp_vdata {
6424b394a23SGary R Hook 	const unsigned int version;
643*efc989fcSGary R Hook 	const unsigned int dma_chan_attr;
6444b394a23SGary R Hook 	void (*setup)(struct ccp_device *);
64558a690b7SGary R Hook 	const struct ccp_actions *perform;
64658a690b7SGary R Hook 	const unsigned int bar;
64758a690b7SGary R Hook 	const unsigned int offset;
64858a690b7SGary R Hook };
64958a690b7SGary R Hook 
6509ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv3;
6519ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv5a;
6529ddb9dc6SGary R Hook extern const struct ccp_vdata ccpv5b;
65358a690b7SGary R Hook 
65463b94509STom Lendacky #endif
655