cbmioctl.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 1999 Michael Klein <michael(dot)klein(at)puffin(dot)lb(dot)shuttle(dot)de>
 *  Copyright 2001-2006,2008-2009 Spiro Trikaliotis
 *  Copyright 2009      Arnd <arnd(at)jonnz(dot)de>
*/

#ifndef CBM_IOCTL_H
#define CBM_IOCTL_H

typedef
enum iec_cabletype
{
    IEC_CABLETYPE_UNSPEC = -2, /*< don't use! */
    IEC_CABLETYPE_AUTO = -1, IEC_CABLETYPE_XM = 0, IEC_CABLETYPE_XA = 1,
    IEC_CABLETYPE_XE
} IEC_CABLETYPE;



#define CBM_REGKEY_SERVICE "System\\CurrentControlSet\\Services\\opencbm"

#define CBM_REGKEY_SERVICE_DEFAULTLPT "DefaultLpt"

#define CBM_REGKEY_SERVICE_IECCABLE "CableType"

#define CBM_REGKEY_SERVICE_PERMLOCK "PermanentlyLock"

#define CBM_REGKEY_SERVICE_DEBUGFLAGS "DebugFlags"

#define CBM_REGKEY_SERVICE_DLL_DEBUGFLAGS "DllDebugFlags"

#define OPENCBM_DRIVERNAME "opencbm"

#define CBMDEVICENAME_MAINPART "\\\\.\\" OPENCBM_DRIVERNAME

// {9C3B5B5E-558E-47cc-9C05-F1FCF5175407}
DEFINE_GUID(GUID_OPENCBM, 0x9c3b5b5e, 0x558e, 0x47cc, 0x9c, 0x5, 0xf1, 0xfc, 0xf5, 0x17, 0x54, 0x7);

#define IEC_LINE_DATA   0x01

#define IEC_LINE_CLOCK  0x02

#define IEC_LINE_ATN    0x04

#define IEC_LINE_RESET  0x08


// Data structures for accessing the kernel mode driver:

typedef
struct CBMT_IECADDRESS
{
    UCHAR PrimaryAddress;

    UCHAR SecondaryAddress;

} CBMT_IECADDRESS;

typedef
struct CBMT_SINGLEBYTE
{
    UCHAR Byte;

} CBMT_SINGLEBYTE;

typedef
struct CBMT_LINE
{
    UCHAR Line;

} CBMT_LINE;

typedef
struct CBMT_LINESTATE
{
    UCHAR Line;

    UCHAR State;

} CBMT_LINE_STATE;

typedef
struct CBMT_BOOLEAN
{
    BOOLEAN Decision;

} CBMT_BOOLEAN;

#define CBMT_I_INSTALL_OUT_GET_VERSION_MAJOR(_x)    (((_x) >> 24) & 0xFF)

#define CBMT_I_INSTALL_OUT_GET_VERSION_MINOR(_x)    (((_x) >> 16) & 0xFF)

#define CBMT_I_INSTALL_OUT_GET_VERSION_SUBMINOR(_x) (((_x) >>  8) & 0xFF)

#define CBMT_I_INSTALL_OUT_GET_VERSION_DEVEL(_x)    (((_x) >>  0) & 0xFF)

#define CBMT_I_INSTALL_OUT_MAKE_VERSION(_x, _y, _z, _w) \
    (((((_x) << 8 | (_y)) << 8 | (_z)) << 8 | (_w)))


#define CBMT_I_INSTALL_OUT_GET_VERSION_EX_BUGFIX(_x) (((_x) >>  0) & 0xFF)

#define CBMT_I_INSTALL_OUT_MAKE_VERSION_EX(_w) \
    (_w)

typedef
struct CBMT_I_INSTALL_OUT
{
    ULONG ErrorFlags;

    ULONG DllVersion;

    ULONG DriverVersion;

    ULONG DllVersionEx;

    ULONG DriverVersionEx;

} CBMT_I_INSTALL_OUT, *PCBMT_I_INSTALL_OUT;

typedef
struct CBMT_I_TESTIRQ
{
    CHAR ErrAcquireIrq;

    CHAR ErrIrqRisingEdge;

    CHAR ErrIrqFallingEdge;

} CBMT_I_TESTIRQ, *PCBMT_I_TESTIRQ;

typedef
struct CBMT_IEC_DBG_VALUE
{
    UCHAR Value;   
} CBMT_IEC_DBG_VALUE;

typedef CBMT_IECADDRESS CBMT_TALK_IN;
typedef CBMT_IECADDRESS CBMT_LISTEN_IN;
typedef CBMT_IECADDRESS CBMT_OPEN_IN;
typedef CBMT_IECADDRESS CBMT_CLOSE_IN;
typedef CBMT_SINGLEBYTE CBMT_PP_WRITE_IN;
typedef CBMT_SINGLEBYTE CBMT_PP_READ_OUT;
typedef CBMT_LINE       CBMT_IEC_POLL_OUT;
typedef CBMT_LINE_STATE CBMT_IEC_WAIT_IN;
typedef CBMT_LINE       CBMT_IEC_WAIT_OUT;
typedef CBMT_LINE       CBMT_IEC_SET_IN;
typedef CBMT_LINE       CBMT_IEC_RELEASE_IN;
typedef CBMT_BOOLEAN    CBMT_GET_EOI_OUT;
typedef CBMT_LINE_STATE CBMT_IEC_SETRELEASE_IN;
typedef CBMT_SINGLEBYTE CBMT_PARBURST_PREAD_OUT;
typedef CBMT_SINGLEBYTE CBMT_PARBURST_PWRITE_IN;
typedef CBMT_IEC_DBG_VALUE CBMT_IEC_DBG_READ;
typedef CBMT_IEC_DBG_VALUE CBMT_IEC_DBG_WRITE;


#define CBMCTRL_BASE    0x0000A424

#define OPENCBM_IOCTL_INDEX  0x823

#define _CBMIO(_a,_b) CTL_CODE(CBMCTRL_BASE, (OPENCBM_IOCTL_INDEX+(_b)), \
                   METHOD_BUFFERED, FILE_ANY_ACCESS)

                                                  // INPUT:               OUTPUT:
#define CBMCTRL_TALK        _CBMIO(CBMCTRL_BASE, 0)  // CBMT_TALK_IN         -
#define CBMCTRL_LISTEN      _CBMIO(CBMCTRL_BASE, 1)  // CBMT_LISTEN_IN       -
#define CBMCTRL_UNTALK      _CBMIO(CBMCTRL_BASE, 2)  // -                    -
#define CBMCTRL_UNLISTEN    _CBMIO(CBMCTRL_BASE, 3)  // -                    -
#define CBMCTRL_OPEN        _CBMIO(CBMCTRL_BASE, 4)  // CBMT_OPEN_IN         -
#define CBMCTRL_CLOSE       _CBMIO(CBMCTRL_BASE, 5)  // CBMT_CLOSE_IN        -
#define CBMCTRL_RESET       _CBMIO(CBMCTRL_BASE, 6)  // -                    -
#define CBMCTRL_GET_EOI     _CBMIO(CBMCTRL_BASE, 7)  // -                    CBMT_GET_EOI_OUT
#define CBMCTRL_CLEAR_EOI   _CBMIO(CBMCTRL_BASE, 8)  // -                    -

#define CBMCTRL_PP_READ     _CBMIO(CBMCTRL_BASE, 10) // -                    CBMT_PP_READ_OUT
#define CBMCTRL_PP_WRITE    _CBMIO(CBMCTRL_BASE, 11) // CBMT_PP_WRITE_IN     -
#define CBMCTRL_IEC_POLL    _CBMIO(CBMCTRL_BASE, 12) // -                    CBMT_IEC_POLL_OUT
#define CBMCTRL_IEC_SET     _CBMIO(CBMCTRL_BASE, 13) // CBMT_IEC_SET_IN      -
#define CBMCTRL_IEC_RELEASE _CBMIO(CBMCTRL_BASE, 14) // CBMT_IEC_RELEASE_IN  -
#define CBMCTRL_IEC_WAIT    _CBMIO(CBMCTRL_BASE, 15) // CBMT_IEC_WAIT_IN     CBMT_IEC_WAIT_OUT

#define CBMCTRL_I_INSTALL   _CBMIO(CBMCTRL_BASE, 16) // -                    CBMT_I_INSTALL_OUT (or an array of it)

#if DBG
#define CBMCTRL_I_READDBG   _CBMIO(CBMCTRL_BASE, 17) // -                    char array which will be filled
#endif // #if DBG

#define CBMCTRL_IEC_SETRELEASE _CBMIO(CBMCTRL_BASE, 18) // CBMT_IEC_SETRELEASE_IN -

#define CBMCTRL_PARBURST_READ \
                            _CBMIO(CBMCTRL_BASE, 19) // CBMT_IEC_PARBURST_PREAD_IN -

#define CBMCTRL_PARBURST_WRITE \
                            _CBMIO(CBMCTRL_BASE, 20) // -                    CBMT_IEC_PARBURST_PWRITE_OUT

#define CBMCTRL_PARBURST_READ_TRACK \
                            _CBMIO(CBMCTRL_BASE, 21) // -                    CBMT_PARBURST_READ_TRACK_OUT

#define CBMCTRL_PARBURST_WRITE_TRACK \
                            _CBMIO(CBMCTRL_BASE, 22) // CBMT_PARBURST_WRITE_TRACK_IN -

#define CBMCTRL_PARPORT_LOCK  \
                            _CBMIO(CBMCTRL_BASE, 23) // -                    -

#define CBMCTRL_PARPORT_UNLOCK  \
                            _CBMIO(CBMCTRL_BASE, 24) // -                    -

#define CBMCTRL_UPDATE \
                            _CBMIO(CBMCTRL_BASE, 25) // -                    -

#define CBMCTRL_TEST_IRQ \
                            _CBMIO(CBMCTRL_BASE, 26) // -                    -

#define CBMCTRL_IEC_DBG_READ  _CBMIO(CBMCTRL_BASE, 27) // CBMT_IEC_DBG_READ    -

#define CBMCTRL_IEC_DBG_WRITE _CBMIO(CBMCTRL_BASE, 28) // -                    CBMT_IEC_DBG_WRITE


#define CBMCTRL_PARBURST_READ_TRACK_VAR \
                            _CBMIO(CBMCTRL_BASE, 29) // -                    CBMT_PARBURST_READ_TRACK_OUT

/* these are the return codes of CBMCTRL_I_INSTALL: */

#define CBM_I_DRIVER_INSTALL_0_FAILED         0xFFFFFFFF
#define CBM_I_DRIVER_INSTALL_0_IOCTL_FAILED   0xFFFFFFFE
#define CBM_I_DRIVER_INSTALL_0M_NO_INTERRUPT  0x80000000

#endif /* #ifndef CBM_IOCTL_H */