sci_global.h

IBM source for pallas/vulcan/vesta

/*-----------------------------------------------------------------------------+
|       This source code has been made available to you by IBM on an AS-IS
|       basis.  Anyone receiving this source is licensed under IBM
|       copyrights to use it in any way he or she deems fit, including
|       copying it, modifying it, compiling it, and redistributing it either
|       with or without modifications.  No license under IBM patents or
|       patent applications is to be implied by the copyright license.
|
|       Any user of this software should understand that IBM cannot provide
|       technical support for this software and will not be responsible for
|       any consequences resulting from the use of this software.
|
|       Any person who transfers this source code or any derivative work
|       must include the IBM copyright notice, this paragraph, and the
|       preceding two paragraphs in the transferred software.
|
|       COPYRIGHT   I B M   CORPORATION 2001
|       LICENSED MATERIAL  -  PROGRAM PROPERTY OF I B M
+-----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------+
| Author:    Mike Lepore
| Component: sci
| File:      sci_global.h
| Purpose:   Some global definition of smart card device driver
| Changes:
|
| Date:       Author            Comment:
| ----------  ----------------  -----------------------------------------------
| 03/22/2001  MAL               Initial check-in.
| 03/26/2001  Zongwei Liu       Port to Linux
| 09/26/2001  Zongwei Liu       Port to pallas
| 10/10/2001  Zongwei Liu       Port to OS-Adaption layer
| 12/13/2001  MAL, Zongwei Liu  Changed SCI_MAX_F to 80000000.
+----------------------------------------------------------------------------*/

#ifndef _sci_global_h_
#define _sci_global_h_

#include "os/os-types.h"

/* constants */

#define SCI_CLASS_A                 1   /* only 5V Vcc to Smart Card */
#define SCI_CLASS_B                 2   /* only 3V Vcc to Smart Card */
#define SCI_CLASS_AB                3   /* 5V or 3V Vcc to Smart Card */
#define SCI_NUMBER_OF_CONTROLLERS   2   /* number of SCI controllers */

#define SCI_BUFFER_SIZE             512

#define SCI_CLOCK_STOP_DISABLED     0
#define SCI_CLOCK_STOP_LOW          1
#define SCI_CLOCK_STOP_HIGH         2

#define SCI_MAX_ATR_SIZE            33

#define SCI_MAX_F                   80000000
#define SCI_MAX_ETU                 0xFFF
#define SCI_MAX_WWT                 0xFFFFFFFF
#define SCI_MAX_CWT                 0xFFFF
#define SCI_MAX_BWT                 0xFFFFFFFF
#define SCI_MAX_EGT                 0xFF

#define SCI_MIN_F                   1000000
#define SCI_MIN_ETU                 8
#define SCI_MIN_WWT                 12
#define SCI_MIN_CWT                 12
#define SCI_MIN_BWT                 971
#define SCI_MIN_EGT                 0

/* read_write mode flags */
#define SCI_SYNC                    0x00000001
#define SCI_DATA_ANY                0x00000002

/* Reserved for Future Use defined as 0 */
#define RFU                         0

/* error codes */
typedef enum
{
    SCI_ERROR_OK = 0,
    SCI_ERROR_DRIVER_NOT_INITIALIZED = -1691,
    SCI_ERROR_FAIL,
    SCI_ERROR_KERNEL_FAIL,
    SCI_ERROR_NO_ATR,
    SCI_ERROR_TS_CHARACTER_INVALID,
    SCI_ERROR_LRC_FAIL,
    SCI_ERROR_CRC_FAIL,
    SCI_ERROR_LENGTH_FAIL,
    SCI_ERROR_PARITY_FAIL,
    SCI_ERROR_RX_OVERFLOW_FAIL,
    SCI_ERROR_TX_OVERFLOW_FAIL,
    SCI_ERROR_TX_UNDERRUN_FAIL,
    SCI_ERROR_CARD_NOT_PRESENT,
    SCI_ERROR_CARD_NOT_ACTIVATED,
    SCI_ERROR_AWT_TIMEOUT,
    SCI_ERROR_WWT_TIMEOUT,
    SCI_ERROR_CWT_TIMEOUT,
    SCI_ERROR_BWT_TIMEOUT,
    SCI_ERROR_PARAMETER_OUT_OF_RANGE,
    SCI_ERROR_TRANSACTION_ABORTED,
    SCI_ERROR_CLOCK_STOP_DISABLED,
    SCI_ERROR_TX_PENDING,
    SCI_ERROR_ATR_PENDING
}
SCI_ERROR;

/* SCI driver modes */
typedef struct sci_modes
{
    INT emv2000;
    INT dma;
    INT man_act;
    INT rw_mode;
}
SCI_MODES;

/* SCI communication parameters */
typedef struct sci_parameters
{
    UCHAR T;
    ULONG f;
    ULONG ETU;
    ULONG WWT;
    ULONG CWT;
    ULONG BWT;
    ULONG EGT;
    ULONG clock_stop_polarity;
    UCHAR check;
    UCHAR P;
    UCHAR I;
    UCHAR U;
}
SCI_PARAMETERS;

/* SCI ATR status */
typedef enum
{
    SCI_WITHOUT_ATR = 0,
    SCI_ATR_READY
}
SCI_ATR_STATUS;

#endif /* _sci_global_h_ */