i_iec.h

Go to the documentation of this file.

/*
 *  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 of the License, or (at your option) any later version.
 *
 *  Copyright 2004, 2007 Spiro Trikaliotis
 *
 */

#ifndef I_CBMIEC_H
#define I_CBMIEC_H

#include "iec.h"

/* The port addresses (relative) of the parallel port */

#define PARALLEL_DATA_OFFSET 0

#define PARALLEL_STATUS_OFFSET 1

#define PARALLEL_CONTROL_OFFSET 2

#define PARALLEL_REGISTER_SPAN 3


/* lpt output lines */
/* this is correct for a XA1541/XM1541; a XE1541 has DATA and RESET exchanged! */

#define PP_ATN_OUT    (Pdx->IecAtnOut)   
#define PP_CLK_OUT    (Pdx->IecClkOut)   
#define PP_DATA_OUT   (Pdx->IecDataOut)  
#define PP_RESET_OUT  (Pdx->IecResetOut) 

/* additional LP control */
#define PP_LP_IRQ     0x10            
#define PP_LP_BIDIR   0x20            

/* lpt input lines */
#define PP_ATN_IN     (Pdx->IecAtnIn)   
#define PP_CLK_IN     (Pdx->IecClkIn)   
#define PP_DATA_IN    (Pdx->IecDataIn)  
#define PP_RESET_IN   (Pdx->IecResetIn) 


#define PAR_PORT (Pdx->ParPortPortAddress + PARALLEL_DATA_OFFSET)

#define IN_PORT  (Pdx->ParPortPortAddress + PARALLEL_STATUS_OFFSET)

#define OUT_PORT (Pdx->ParPortPortAddress + PARALLEL_CONTROL_OFFSET)

#define CBMIEC_SET(_set)              do { DBG_ASSERT((_set) != 0); Pdx->IecOutBits|=(_set); WRITE_PORT_UCHAR(OUT_PORT,(UCHAR)(Pdx->IecOutEor ^ Pdx->IecOutBits)); } while (0)

#define CBMIEC_RELEASE(_rel)          do { DBG_ASSERT((_rel) != 0); Pdx->IecOutBits&=~(_rel); WRITE_PORT_UCHAR(OUT_PORT,(UCHAR)(Pdx->IecOutEor ^ Pdx->IecOutBits)); } while (0)

#define CBMIEC_SET_RELEASE(_set,_rel) do { DBG_ASSERT((_set) != 0); DBG_ASSERT((_rel) != 0); Pdx->IecOutBits|=(_set); Pdx->IecOutBits&=~(_rel); \
                                      WRITE_PORT_UCHAR(OUT_PORT,(UCHAR)(Pdx->IecOutEor ^ Pdx->IecOutBits)); } while (0)

#define CBMIEC_ARE_OUTPUT_LINES_CORRECT() ( READ_PORT_UCHAR(OUT_PORT) == (UCHAR)(Pdx->IecOutEor ^ Pdx->IecOutBits) )

#define CBMIEC_GET(_line)             (((READ_PORT_UCHAR(IN_PORT) ^ Pdx->IecInEor) & _line)==0?1:0)


typedef
struct IEC_TIMEOUTS
{
    ULONG T_holdreset;
    ULONG T_afterreset;

    ULONG T_WaitForListener_Granu_T_H;

    ULONG T_1_RECV_WAIT_CLK_LOW_DATA_READY_GRANU;

    ULONG T_2_Times;

    ULONG T_2_RECV_WAIT_CLK_HIGH_T_NE;

    ULONG T_3_RECV_EOI_RECOGNIZED;

    ULONG T_4_Times;

    ULONG T_4_RECV_WAIT_CLK_HIGH_AFTER_EOI_GRANU;

    ULONG T_5_Times;

    ULONG T_5_RECV_BIT_WAIT_CLK_HIGH;

    ULONG T_6_Times;

    ULONG T_6_RECV_BIT_WAIT_CLK_LOW;

    ULONG T_7_RECV_INTER_BYTE_DELAY;

    ULONG T_8_IEC_WAIT_LONG_DELAY;

    ULONG T_8_IEC_WAIT_SHORT_DELAY;

    ULONG T_9_Times;

    ULONG T_9_SEND_WAIT_DEVICES_T_AT;

    ULONG T_10_SEND_BEFORE_1ST_BYTE;

    ULONG T_11_SEND_BEFORE_BYTE_DELAY;

    ULONG T_12_SEND_AFTER_BYTE_DELAY;

    ULONG T_13_SEND_TURN_AROUND_LISTENER_TALKER_T_TK;

    ULONG T_14_SEND_AT_END_DELAY;

    // sendbyte related:

    ULONG T_15_SEND_BEFORE_BIT_DELAY_T_S;

    ULONG T_16_SEND_BIT_TIME_T_V;

    ULONG T_17_Times;

    ULONG T_17_SEND_FRAME_HANDSHAKE_T_F;

    ULONG T_PARALLEL_BURST_READ_BYTE_HANDSHAKED;

    ULONG T_PARALLEL_BURST_WRITE_BYTE_HANDSHAKED;

} IEC_TIMEOUTS;

extern IEC_TIMEOUTS libiec_global_timeouts;

#if DBG

/* The functions DbgWp() and DbgRp() are used to intercept
 * NDIS_WRITE_PORT() and NDIS_READ_PORT() when debugging.
 */
extern VOID
DbgWp(IN PUCHAR Port, IN UCHAR Value);

extern UCHAR
DbgRp(IN PUCHAR Port);

extern VOID
cbmiec_show_port(UCHAR *s);

/*
 * If DBG is defined, we want to be able to monitor every
 * READ_PORT_UCHAR and WRITE_PORT_UCHAR, so we override them
 * here with our own functions:
 */

#define READ_PORT_UCHAR(_x_)       DbgRp(_x_)

#define WRITE_PORT_UCHAR(_x_, _y_) DbgWp(_x_, _y_)

/*
 *  dump input lines
 */
extern VOID
cbmiec_show_state(IN PDEVICE_EXTENSION Pdx, IN UCHAR *Str);

#else /* #if DBG */

    #define cbmiec_show_state(_x_, _y_)

#endif /* #if DBG */

extern VOID
cbmiec_schedule_timeout(IN ULONG howlong); // howlong in us!

extern VOID
cbmiec_udelay(IN ULONG howlong); // howlong in ms!

extern NTSTATUS
cbmiec_i_raw_read(IN PDEVICE_EXTENSION Pdx, OUT UCHAR *buf, ULONG cnt, OUT ULONG *pReceived);

extern NTSTATUS
cbmiec_i_raw_write(PDEVICE_EXTENSION Pdx, const UCHAR *buf, ULONG cnt, ULONG *pSent, BOOLEAN atn, BOOLEAN talk);

extern VOID
cbmiec_block_irq(PDEVICE_EXTENSION Pdx);

extern VOID
cbmiec_release_irq(PDEVICE_EXTENSION Pdx);

extern LONG
cbmiec_i_pp_read_debounced(IN PDEVICE_EXTENSION Pdx);


typedef
enum cablestate_e
{
    CABLESTATE_UNKNOWN,            
    CABLESTATE_ERROR_OCCURRED,     
    CABLESTATE_TESTED,             
    CABLESTATE_SUCCESSFULLY_USED   
} CABLESTATE;

extern VOID
cbmiec_setcablestate(PDEVICE_EXTENSION Pdx, CABLESTATE State);

#ifdef USE_DPC

    extern VOID
    cbmiec_dpc(IN PKDPC Dpc, IN PDEVICE_OBJECT Fdo, IN PIRP Irp, IN PVOID Context);

#endif // #ifdef USE_DPC

#endif /* #ifndef I_CBMIEC_H */