workbench/hidds/tap/include/tap.h

   1 #ifndef HIDD_TAP_H
   2 #define HIDD_TAP_H
   3
   4 /*
   5     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   6     $Id$
   7
   8     Desc: Definitions for the Tap HIDD system.
   9     Lang: english
  10 */
  11
  12 #ifndef EXEC_TYPES_H
  13 #   include <exec/types.h>
  14 #endif
  15 #ifndef HIDD_HIDD_H
  16 #   include <hidd/hidd.h>
  17 #endif
  18 #ifndef OOP_OOP_H
  19 #   include <oop/oop.h>
  20 #endif
  21
  22 #include <utility/utility.h>
  23
  24
  25 #define CLID_Hidd_Tap           "hidd.network.tap"
  26 #define CLID_Hidd_TapUnit       "hidd.network.tapunit"
  27
  28 #define IID_Hidd_Tap            "hidd.network.tap"
  29 #define IID_Hidd_TapUnit        "hidd.network.tapunit"
  30
  31
  32
  33 /**** Graphics definitions ****************************************************/
  34
  35 #ifndef __OOP_NOATTRBASES__
  36 extern OOP_AttrBase HiddTapUnitAB;
  37 #endif
  38
  39 enum {
  40     aoHidd_TapUnit_Unit,
  41
  42     num_Hidd_TapUnit_Attrs
  43
  44 };
  45
  46 #define aHidd_TapUnit_Unit              (HiddTapUnitAB + aoHidd_TapUnit_Unit)
  47
  48 #define IS_HIDDTAPUNIT_ATTR(attr, idx) IS_IF_ATTR(attr, idx, HiddTapUnitAB, num_Hidd_TapUnit_Attrs)
  49
  50 enum
  51 {
  52     moHidd_Tap_NewUnit = 0,
  53     moHidd_Tap_DisposeUnit,
  54     moHidd_Tap_NumMethods               // always keep this the last one!
  55 };
  56
  57
  58
  59
  60 struct pHidd_Tap_NewUnit
  61 {
  62     OOP_MethodID        mID;
  63     ULONG               unitnum;
  64 };
  65
  66 struct pHidd_Tap_DisposeUnit
  67 {
  68     OOP_MethodID        mID;
  69     OOP_Object          *unit;
  70 };
  71
  72
  73 /**** Tap Unit definitions ******************************************************/
  74
  75
  76 enum
  77 {
  78     /* Methods for a tap unit */
  79
  80     moHidd_TapUnit_Init,
  81     moHidd_TapUnit_Write,
  82     moHidd_TapUnit_Start,
  83     moHidd_TapUnit_Stop,
  84     moHidd_TapUnit_GetStatus,
  85     moHidd_TapUnit_NumMethods   // always keep this the last one!
  86 };
  87
  88
  89 /* messages for a Tap unit */
  90
  91 struct pHidd_TapUnit_Init
  92 {
  93     OOP_MethodID        mID;
  94     VOID                *DataReceived;
  95     VOID                *DataReceivedUserData;
  96     VOID                *WriteData;
  97     VOID                *WriteDataUserData;
  98 };
  99
 100 struct pHidd_TapUnit_Write
 101 {
 102     OOP_MethodID        mID;
 103     ULONG               Length;
 104     UBYTE               *Outbuffer;
 105 };
 106
 107 struct pHidd_TapUnit_Start
 108 {
 109     OOP_MethodID        mID;
 110 };
 111
 112 struct pHidd_TapUnit_Stop
 113 {
 114     OOP_MethodID        mID;
 115 };
 116
 117 struct pHidd_TapUnit_GetStatus
 118 {
 119     OOP_MethodID        mID;
 120 };
 121
 122 /* Predeclarations of stubs in libhiddTapstubs.h */
 123
 124 OOP_Object * HIDD_Tap_NewUnit   (OOP_Object *obj, ULONG unitnum);
 125 VOID     HIDD_Tap_DisposeUnit   (OOP_Object *obj, OOP_Object *unit);
 126
 127 BOOL     HIDD_TapUnit_Init              (OOP_Object *obj, VOID * DataReceived, VOID * DataReceivedUserData, VOID * WriteData, VOID * WriteDataUserData);
 128 ULONG    HIDD_TapUnit_Write     (OOP_Object *obj, UBYTE * data, ULONG length);
 129 VOID     HIDD_TapUnit_Start        (OOP_Object *obj);
 130 VOID     HIDD_TapUnit_Stop         (OOP_Object *obj);
 131 UWORD    HIDD_TapUnit_GetStatus    (OOP_Object *obj);
 132
 133 #endif /* HIDD_TAP_H */