/*
   * CAAM/SEC 4.x driver backend
   * Private/internal definitions between modules
   *
   * Copyright 2008-2015 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 device *smdev;
  	struct platform_device **jrpdev; /* Alloc'ed array per sub-device */
  	struct platform_device *pdev;
  
  	/* Physical-presence section */
  	struct caam_ctrl *ctrl; /* controller region */
  	struct caam_deco **deco; /* DECO/CCB views */
  	struct caam_assurance *ac;
  	struct caam_queue_if *qi; /* QI control region */
  	dma_addr_t __iomem *sm_base;	/* Secure memory storage base */
  	u32 sm_size;
  
  	/*
  	 * 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 */
  
  #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 */
  
  #ifdef CONFIG_ARM
  	struct clk *caam_ipg;
  	struct clk *caam_mem;
  	struct clk *caam_aclk;
  	struct clk *caam_emi_slow;
  #endif
  
  	/*
  	 * 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 */