des_io.h

Go to the documentation of this file.

/****************************************************************************
*
*     Axis 2 PCI Linux Kernel driver
*     File:    des_io.h
*     Version: 1.0
*     Copyright 2004 Heber Limited (http://www.heber.co.uk)
*
*     This program is free software; you can redistribute it and/or modify it
*     under the terms of the GNU General Public License as published by the
*     Free Software Foundation; either version 2, or (at your option) any
*     later version.
*
*     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.
*
*     You should have received a copy of the GNU General Public License along
*     with this program; if not, write to the Free Software Foundation, Inc.,
*     675 Mass Ave, Cambridge, MA 02139, USA.
*
*     Changes:
*
****************************************************************************/
#ifndef AXIS_DES_IO_H
#define AXIS_DES_IO_H
#ifndef _LINUX_KERNEL_H

#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/version.h>
#include <linux/module.h>
#include <linux/proc_fs.h>
#include <linux/delay.h>
#include <linux/pci.h>
#include <linux/list.h>
#include <linux/ioport.h>
#include <linux/serial.h>
#include <linux/interrupt.h>
#include <linux/string.h>
#include <linux/spinlock.h>
#include <linux/mtd/mtd.h>
#include <linux/crypto.h>
#include <asm/uaccess.h>

#endif  //_LINUX_KERNEL_H

#ifndef AXIS_HARDWARE_H
#include "axis_hardware.h"
#endif //AXIS_HARDWARE_H


#define DES_A_REG                           (0x50+CONTROL_OFFSET)
#define DES_B_REG                           (0x54+CONTROL_OFFSET)
#define DES_C_REG                           (0x58+CONTROL_OFFSET)
#define DES_D_REG                           (0x5C+CONTROL_OFFSET)

#define DES_A_BUFFER                        (0)
#define DES_B_BUFFER                        (0x200)
#define DES_C_BUFFER                        (0x400)
#define DES_D_BUFFER                        (0x600)

#define DES_START_BIT   (1<<0)
#define DES_ENCRYPT_BIT (1<<1)
#define DES_MASTER_BIT  (1<<2)



#define HEBER_DES3_BLOCK_SIZE           8
#define HEBER_DES3_KEY_SIZE             24

/*----------------------des related defines ----------------------*/
#define NUMBER_OF_KEY_STORES 16
#define NUMBER_OF_DES_CHANNELS 3 //keep channel 4 for key management
#define MAX_DES_OPS 512
#define KEY_SIZE 192
#define INTERNAL_KEY_SIZE 0x20  // gate array has space for 256 bits per key


/*
The system has to deal with having a finite number of hardware key stores less than
the possible number of transactions so hardware key storage must be reused.

The solution each device has an array of axis_des_hardware_key structures each hardware key
has a lock. If locked the key is either in use or scheuled for use and cannot be freed. The
age member allows the use of a LRU algorithm to reclaim hardware keys.

Each file operations structure has a software key storage associated with it. A write operation will
cause the system to check if it has a current hardware key if it doesn't it will request (waiting if necessary)
one.
The key will be locked and if its not loaded it will be loaded.
Once the key is loaded the operation will be queued upon a DES buffer. Once a DES buffer becomes available
the operation is started and waits for completion.
On completion the results are copied either back to kernel memory or to a buffer. The DES buffer is unlocked
as is the hardware key storage.

*/

struct axis_des_key;

struct axis_des_hardware_key
{
    unsigned        lock    ;               
    unsigned        loaded  ;               
    unsigned long   age     ;               
    unsigned char * address ;               
    unsigned char * register_address;       
    unsigned        index   ;               
    struct axis_des_key * software_key ;    
};
struct axis_des_hardware_channel
{
    unsigned            lock    ;               
    unsigned char *     buffer_address  ;       
    unsigned char *     register_address;       
    wait_queue_head_t   queue       ;           
    volatile int                done        ;   
    volatile unsigned long      start_time ;    
};

struct axis_des_key
{
    unsigned char Key0[8]               ;   
    unsigned char Key1[8]               ;   
    unsigned char Key2[8]               ;   
    int encrypt                         ;   
    int master                          ;   
    int raw                         ;   
    struct axis_des_hardware_key * hardware_key ;
};

struct crypto_state
{
    struct axis_des_key  key ;                      
    struct axis_pci_device_entry * device ;         
} ;

struct axis_des_op
{
    unsigned long flags ;                       ;   
    struct axis_des_key * key                   ;   
    struct axis_des_hardware_channel * channel  ;   
    unsigned int no_to_do                       ;   
    unsigned char * buffer                      ;   
    struct axis_pci_device_entry * device       ;   
    unsigned char local[512]                    ;   
};


//export function to initialise DES hardware key structures
void init_axis_des_hardware_key(struct axis_des_hardware_key * ptr,
                                            unsigned char * addr,
                                            unsigned char * reg,int index);

//export function to initialise DES hardware channel structures
void init_axis_des_hardware_channel(struct axis_des_hardware_channel * ptr,
                                                unsigned char * reg,
                                                unsigned char * buffer,
                                                unsigned index);


void init_axis_des_core(struct axis_pci_device_entry * device);
//export file operations structure for cypto device
extern struct file_operations crypto_file_operations ;

#endif  //AXIS_DES_IO_H

---