/*
<:copyright-BRCM:2007:GPL/GPL:standard

   Copyright (c) 2007 Broadcom 
   All Rights Reserved

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 (the "GPL").

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.


A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by
writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.

:>
*/
/******************************************************************************
 * File Name  : spudrv.h
 *
 * Description: This file contains Linux character device driver data
 *              structures for the IPSec SPU.
 *
 * Updates    : 11/16/2007  Pavan Kumar.  Created.
 ***************************************************************************/
#ifndef __SPUDRV_H__
#define __SPUDRV_H__

#include <linux/device.h>
#include <linux/cdev.h>

#if 0
#define SPU_DEBUG 1
#define SPU_DEBUG_PKT 1
#endif

#ifdef SPU_DEBUG
#define SPU_TRACE(x)        printk x
#else
#define SPU_TRACE(x)
#endif

#ifdef SPU_DEBUG_PKT
#define SPU_DATA_DUMP(x, y, z) spu_dump_array(x, y, z)
#else
#define SPU_DATA_DUMP(x, y, z)
#endif

#define SPU_NUM_DEVICES 1
#define SPU_DEVICE_NAME "spu"

#define DMA_MAX_BURST_LENGTH         8
#define DESC_ALIGN                   16
#define BUF_ALIGN                    4
#define IPSEC_SPU_MSEC_PER_TICK      (1000/HZ)
#define IPSEC_SPU_ALIGN(addr, bound) (((UINT32) addr + bound - 1) & ~(bound - 1))

#define DEV_ALIGN               32
#define DEV_ALIGN_CONST         (DEV_ALIGN - 1)
#define NR_XMIT_BDS             512
#define NR_RX_BDS               128
#define RX_BUF_SIZE             8192
#define CACHE_TO_NONCACHE(x)    KSEG1ADDR(x)
#define NONCACHE_TO_CACHE(x)    KSEG0ADDR(x)

// Cache related definitions and inline functions.
#define CACHE_LINE_SIZE                  16	// should read from CP0 config, 1
#define Hit_Invalidate_D                 0x11
#define Hit_Writeback_Inv_D              0x15	/* 5       1 */

#define XTRA_DMA_HDR_SIZE            1024
#define UBSEC_CIPHER_LIST            0
#define IPSEC_SPU_ALIGN(addr, bound) (((UINT32) addr + bound - 1) & ~(bound - 1))
#define ALIGN_SIZE                   4

#define CACHED_TO_UNCACHED(x)   KSEG1ADDR(x)
#define UNCACHED_TO_CACHED(x)   KSEG0ADDR(x)
#define VIRT_TO_PHYS(x)         CPHYSADDR(x)
#define PHYS_TO_CACHED(x)       ((x) | KSEG0)
#define PHYS_TO_UNCACHED(x)     ((x) | KSEG1)

typedef struct spu_dev_ctrl_s
{
    spinlock_t spin_lock;
    int        tx_free_bds;
    int        tx_head;
    int        tx_tail;
    int        rx_free_bds;
    int        rx_head;
    int        rx_tail;
    int        rx_irq;

    unsigned int     *txBdsBase;
    unsigned int     *rxBdsBase;
    volatile DmaDesc *tx_bds;
    volatile DmaDesc *rx_bds;
   
    volatile DmaRegs       *dma_ctrl;
    volatile DmaChannelCfg *tx_dma;
    volatile DmaChannelCfg *rx_dma;
    void                   *spu_linux;
    struct tasklet_struct   task;
#ifdef CONFIG_BCM_SPU_TEST
    int                     test_mode;
#endif
    SPU_STAT_PARMS stats;
} spu_dev_ctrl_t, *pspu_dev_ctrl_t;

struct spu_device {
    int                       major;
    struct class             *spu_class;
    struct cdev               cdev;
    struct device            *device;
    struct file_operations    spu_file_ops;
};  

#endif /* __SPUDRV_H__ */