Release 4.7 drivers/crypto/ccp/ccp-dev.h
  
  
/*
 * AMD Cryptographic Coprocessor (CCP) driver
 *
 * Copyright (C) 2013,2016 Advanced Micro Devices, Inc.
 *
 * Author: Tom Lendacky <thomas.lendacky@amd.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#ifndef __CCP_DEV_H__
#define __CCP_DEV_H__
#include <linux/device.h>
#include <linux/pci.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/list.h>
#include <linux/wait.h>
#include <linux/dmapool.h>
#include <linux/hw_random.h>
#include <linux/bitops.h>
#include <linux/interrupt.h>
#include <linux/irqreturn.h>
#include <linux/dmaengine.h>
#define MAX_CCP_NAME_LEN		16
#define MAX_DMAPOOL_NAME_LEN		32
#define MAX_HW_QUEUES			5
#define MAX_CMD_QLEN			100
#define TRNG_RETRIES			10
#define CACHE_NONE			0x00
#define CACHE_WB_NO_ALLOC		0xb7
/****** Register Mappings ******/
#define Q_MASK_REG			0x000
#define TRNG_OUT_REG			0x00c
#define IRQ_MASK_REG			0x040
#define IRQ_STATUS_REG			0x200
#define DEL_CMD_Q_JOB			0x124
#define DEL_Q_ACTIVE			0x00000200
#define DEL_Q_ID_SHIFT			6
#define CMD_REQ0			0x180
#define CMD_REQ_INCR			0x04
#define CMD_Q_STATUS_BASE		0x210
#define CMD_Q_INT_STATUS_BASE		0x214
#define CMD_Q_STATUS_INCR		0x20
#define CMD_Q_CACHE_BASE		0x228
#define CMD_Q_CACHE_INC			0x20
#define CMD_Q_ERROR(__qs)		((__qs) & 0x0000003f)
#define CMD_Q_DEPTH(__qs)		(((__qs) >> 12) & 0x0000000f)
/****** REQ0 Related Values ******/
#define REQ0_WAIT_FOR_WRITE		0x00000004
#define REQ0_INT_ON_COMPLETE		0x00000002
#define REQ0_STOP_ON_COMPLETE		0x00000001
#define REQ0_CMD_Q_SHIFT		9
#define REQ0_JOBID_SHIFT		3
/****** REQ1 Related Values ******/
#define REQ1_PROTECT_SHIFT		27
#define REQ1_ENGINE_SHIFT		23
#define REQ1_KEY_KSB_SHIFT		2
#define REQ1_EOM			0x00000002
#define REQ1_INIT			0x00000001
/* AES Related Values */
#define REQ1_AES_TYPE_SHIFT		21
#define REQ1_AES_MODE_SHIFT		18
#define REQ1_AES_ACTION_SHIFT		17
#define REQ1_AES_CFB_SIZE_SHIFT		10
/* XTS-AES Related Values */
#define REQ1_XTS_AES_SIZE_SHIFT		10
/* SHA Related Values */
#define REQ1_SHA_TYPE_SHIFT		21
/* RSA Related Values */
#define REQ1_RSA_MOD_SIZE_SHIFT		10
/* Pass-Through Related Values */
#define REQ1_PT_BW_SHIFT		12
#define REQ1_PT_BS_SHIFT		10
/* ECC Related Values */
#define REQ1_ECC_AFFINE_CONVERT		0x00200000
#define REQ1_ECC_FUNCTION_SHIFT		18
/****** REQ4 Related Values ******/
#define REQ4_KSB_SHIFT			18
#define REQ4_MEMTYPE_SHIFT		16
/****** REQ6 Related Values ******/
#define REQ6_MEMTYPE_SHIFT		16
/****** Key Storage Block ******/
#define KSB_START			77
#define KSB_END				127
#define KSB_COUNT			(KSB_END - KSB_START + 1)
#define CCP_KSB_BITS			256
#define CCP_KSB_BYTES			32
#define CCP_JOBID_MASK			0x0000003f
#define CCP_DMAPOOL_MAX_SIZE		64
#define CCP_DMAPOOL_ALIGN		BIT(5)
#define CCP_REVERSE_BUF_SIZE		64
#define CCP_AES_KEY_KSB_COUNT		1
#define CCP_AES_CTX_KSB_COUNT		1
#define CCP_XTS_AES_KEY_KSB_COUNT	1
#define CCP_XTS_AES_CTX_KSB_COUNT	1
#define CCP_SHA_KSB_COUNT		1
#define CCP_RSA_MAX_WIDTH		4096
#define CCP_PASSTHRU_BLOCKSIZE		256
#define CCP_PASSTHRU_MASKSIZE		32
#define CCP_PASSTHRU_KSB_COUNT		1
#define CCP_ECC_MODULUS_BYTES		48      
/* 384-bits */
#define CCP_ECC_MAX_OPERANDS		6
#define CCP_ECC_MAX_OUTPUTS		3
#define CCP_ECC_SRC_BUF_SIZE		448
#define CCP_ECC_DST_BUF_SIZE		192
#define CCP_ECC_OPERAND_SIZE		64
#define CCP_ECC_OUTPUT_SIZE		64
#define CCP_ECC_RESULT_OFFSET		60
#define CCP_ECC_RESULT_SUCCESS		0x0001
struct ccp_op;
/* Structure for computation functions that are device-specific */
struct ccp_actions {
	
int (*perform_aes)(struct ccp_op *);
	
int (*perform_xts_aes)(struct ccp_op *);
	
int (*perform_sha)(struct ccp_op *);
	
int (*perform_rsa)(struct ccp_op *);
	
int (*perform_passthru)(struct ccp_op *);
	
int (*perform_ecc)(struct ccp_op *);
	
int (*init)(struct ccp_device *);
	
void (*destroy)(struct ccp_device *);
	
irqreturn_t (*irqhandler)(int, void *);
};
/* Structure to hold CCP version-specific values */
struct ccp_vdata {
	
unsigned int version;
	
const struct ccp_actions *perform;
};
extern struct ccp_vdata ccpv3;
struct ccp_device;
struct ccp_cmd;
struct ccp_dma_cmd {
	
struct list_head entry;
	
struct ccp_cmd ccp_cmd;
};
struct ccp_dma_desc {
	
struct list_head entry;
	
struct ccp_device *ccp;
	
struct list_head pending;
	
struct list_head active;
	
enum dma_status status;
	
struct dma_async_tx_descriptor tx_desc;
	
size_t len;
};
struct ccp_dma_chan {
	
struct ccp_device *ccp;
	
spinlock_t lock;
	
struct list_head pending;
	
struct list_head active;
	
struct list_head complete;
	
struct tasklet_struct cleanup_tasklet;
	
enum dma_status status;
	
struct dma_chan dma_chan;
};
struct ccp_cmd_queue {
	
struct ccp_device *ccp;
	/* Queue identifier */
	
u32 id;
	/* Queue dma pool */
	
struct dma_pool *dma_pool;
	/* Queue reserved KSB regions */
	
u32 ksb_key;
	
u32 ksb_ctx;
	/* Queue processing thread */
	
struct task_struct *kthread;
	
unsigned int active;
	
unsigned int suspended;
	/* Number of free command slots available */
	
unsigned int free_slots;
	/* Interrupt masks */
	
u32 int_ok;
	
u32 int_err;
	/* Register addresses for queue */
	
void __iomem *reg_status;
	
void __iomem *reg_int_status;
	/* Status values from job */
	
u32 int_status;
	
u32 q_status;
	
u32 q_int_status;
	
u32 cmd_error;
	/* Interrupt wait queue */
	
wait_queue_head_t int_queue;
	
unsigned int int_rcvd;
} 
____cacheline_aligned;
struct ccp_device {
	
struct list_head entry;
	
struct ccp_vdata *vdata;
	
unsigned int ord;
	
char name[MAX_CCP_NAME_LEN];
	
char rngname[MAX_CCP_NAME_LEN];
	
struct device *dev;
	/*
         * Bus specific device information
         */
	
void *dev_specific;
	
int (*get_irq)(struct ccp_device *ccp);
	
void (*free_irq)(struct ccp_device *ccp);
	
unsigned int irq;
	/*
         * I/O area used for device communication. The register mapping
         * starts at an offset into the mapped bar.
         *   The CMD_REQx registers and the Delete_Cmd_Queue_Job register
         *   need to be protected while a command queue thread is accessing
         *   them.
         */
	
struct mutex req_mutex ____cacheline_aligned;
	
void __iomem *io_map;
	
void __iomem *io_regs;
	/*
         * Master lists that all cmds are queued on. Because there can be
         * more than one CCP command queue that can process a cmd a separate
         * backlog list is neeeded so that the backlog completion call
         * completes before the cmd is available for execution.
         */
	
spinlock_t cmd_lock ____cacheline_aligned;
	
unsigned int cmd_count;
	
struct list_head cmd;
	
struct list_head backlog;
	/*
         * The command queues. These represent the queues available on the
         * CCP that are available for processing cmds
         */
	
struct ccp_cmd_queue cmd_q[MAX_HW_QUEUES];
	
unsigned int cmd_q_count;
	/*
         * Support for the CCP True RNG
         */
	
struct hwrng hwrng;
	
unsigned int hwrng_retries;
	/*
         * Support for the CCP DMA capabilities
         */
	
struct dma_device dma_dev;
	
struct ccp_dma_chan *ccp_dma_chan;
	
struct kmem_cache *dma_cmd_cache;
	
struct kmem_cache *dma_desc_cache;
	/*
         * A counter used to generate job-ids for cmds submitted to the CCP
         */
	
atomic_t current_id ____cacheline_aligned;
	/*
         * The CCP uses key storage blocks (KSB) to maintain context for certain
         * operations. To prevent multiple cmds from using the same KSB range
         * a command queue reserves a KSB range for the duration of the cmd.
         * Each queue, will however, reserve 2 KSB blocks for operations that
         * only require single KSB entries (eg. AES context/iv and key) in order
         * to avoid allocation contention.  This will reserve at most 10 KSB
         * entries, leaving 40 KSB entries available for dynamic allocation.
         */
	
struct mutex ksb_mutex ____cacheline_aligned;
	DECLARE_BITMAP(ksb, KSB_COUNT);
	
wait_queue_head_t ksb_queue;
	
unsigned int ksb_avail;
	
unsigned int ksb_count;
	
u32 ksb_start;
	/* Suspend support */
	
unsigned int suspending;
	
wait_queue_head_t suspend_queue;
	/* DMA caching attribute support */
	
unsigned int axcache;
};
enum ccp_memtype {
	
CCP_MEMTYPE_SYSTEM = 0,
	
CCP_MEMTYPE_KSB,
	
CCP_MEMTYPE_LOCAL,
	
CCP_MEMTYPE__LAST,
};
struct ccp_dma_info {
	
dma_addr_t address;
	
unsigned int offset;
	
unsigned int length;
	
enum dma_data_direction dir;
};
struct ccp_dm_workarea {
	
struct device *dev;
	
struct dma_pool *dma_pool;
	
unsigned int length;
	
u8 *address;
	
struct ccp_dma_info dma;
};
struct ccp_sg_workarea {
	
struct scatterlist *sg;
	
int nents;
	
struct scatterlist *dma_sg;
	
struct device *dma_dev;
	
unsigned int dma_count;
	
enum dma_data_direction dma_dir;
	
unsigned int sg_used;
	
u64 bytes_left;
};
struct ccp_data {
	
struct ccp_sg_workarea sg_wa;
	
struct ccp_dm_workarea dm_wa;
};
struct ccp_mem {
	
enum ccp_memtype type;
	union {
		
struct ccp_dma_info dma;
		
u32 ksb;
	} 
u;
};
struct ccp_aes_op {
	
enum ccp_aes_type type;
	
enum ccp_aes_mode mode;
	
enum ccp_aes_action action;
};
struct ccp_xts_aes_op {
	
enum ccp_aes_action action;
	
enum ccp_xts_aes_unit_size unit_size;
};
struct ccp_sha_op {
	
enum ccp_sha_type type;
	
u64 msg_bits;
};
struct ccp_rsa_op {
	
u32 mod_size;
	
u32 input_len;
};
struct ccp_passthru_op {
	
enum ccp_passthru_bitwise bit_mod;
	
enum ccp_passthru_byteswap byte_swap;
};
struct ccp_ecc_op {
	
enum ccp_ecc_function function;
};
struct ccp_op {
	
struct ccp_cmd_queue *cmd_q;
	
u32 jobid;
	
u32 ioc;
	
u32 soc;
	
u32 ksb_key;
	
u32 ksb_ctx;
	
u32 init;
	
u32 eom;
	
struct ccp_mem src;
	
struct ccp_mem dst;
	union {
		
struct ccp_aes_op aes;
		
struct ccp_xts_aes_op xts;
		
struct ccp_sha_op sha;
		
struct ccp_rsa_op rsa;
		
struct ccp_passthru_op passthru;
		
struct ccp_ecc_op ecc;
	} 
u;
};
static inline u32 ccp_addr_lo(struct ccp_dma_info *info)
{
	return lower_32_bits(info->address + info->offset);
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| gary r hook | gary r hook | 24 | 100.00% | 1 | 100.00% | 
 | Total | 24 | 100.00% | 1 | 100.00% | 
static inline u32 ccp_addr_hi(struct ccp_dma_info *info)
{
	return upper_32_bits(info->address + info->offset) & 0x0000ffff;
}
Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| gary r hook | gary r hook | 26 | 100.00% | 1 | 100.00% | 
 | Total | 26 | 100.00% | 1 | 100.00% | 
int ccp_pci_init(void);
void ccp_pci_exit(void);
int ccp_platform_init(void);
void ccp_platform_exit(void);
void ccp_add_device(struct ccp_device *ccp);
void ccp_del_device(struct ccp_device *ccp);
struct ccp_device *ccp_alloc_struct(struct device *dev);
bool ccp_queues_suspended(struct ccp_device *ccp);
int ccp_cmd_queue_thread(void *data);
int ccp_run_cmd(struct ccp_cmd_queue *cmd_q, struct ccp_cmd *cmd);
int ccp_dmaengine_register(struct ccp_device *ccp);
void ccp_dmaengine_unregister(struct ccp_device *ccp);
#endif
Overall Contributors
 | Person | Tokens | Prop | Commits | CommitProp | 
| thomas lendacky | thomas lendacky | 650 | 50.78% | 5 | 50.00% | 
| gary r hook | gary r hook | 629 | 49.14% | 4 | 40.00% | 
| julia lawall | julia lawall | 1 | 0.08% | 1 | 10.00% | 
 | Total | 1280 | 100.00% | 10 | 100.00% | 
  
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.