KernelLand/Modules/Interfaces/UDI/udi_internal.h

   1 /*
   2  * Acess2 UDI Layer
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * udi_internal.h
   6  * - Definitions for opaque structures
   7  */
   8 #ifndef _UDI_INTERNAL_H_
   9 #define _UDI_INTERNAL_H_
  10
  11 #include <stdbool.h>
  12
  13 #define NEW(type,extra) (type*)calloc(sizeof(type)extra,1)
  14 #define NEW_wA(type,fld,cnt)    NEW(type,+(sizeof(((type*)NULL)->fld[0])*cnt))
  15
  16 typedef struct sUDI_PropMessage         tUDI_PropMessage;
  17 typedef struct sUDI_PropRegion  tUDI_PropRegion;
  18 typedef struct sUDI_PropDevSpec tUDI_PropDevSpec;
  19
  20 typedef const struct sUDI_MetaLang      tUDI_MetaLang;
  21
  22 typedef struct sUDI_MetaLangRef         tUDI_MetaLangRef;
  23 typedef struct sUDI_BindOps     tUDI_BindOps;
  24
  25 typedef struct sUDI_DriverModule        tUDI_DriverModule;
  26 typedef struct sUDI_DriverInstance      tUDI_DriverInstance;
  27 typedef struct sUDI_DriverRegion        tUDI_DriverRegion;
  28
  29 typedef struct sUDI_ChildBinding        tUDI_ChildBinding;
  30
  31 struct sUDI_PropMessage
  32 {
  33          int    locale;
  34         udi_ubit16_t    index;
  35         const char      *string;
  36 };
  37
  38 struct sUDI_PropRegion
  39 {
  40         udi_index_t     RegionIdx;
  41         enum {
  42                 UDI_REGIONTYPE_NORMAL,
  43                 UDI_REGIONTYPE_FP,
  44         }       Type;
  45         enum {
  46                 UDI_REGIONBINDING_STATIC,
  47                 UDI_REGIONBINDING_DYNAMIC,
  48         }       Binding;
  49         enum {
  50                 UDI_REGIONPRIO_MED,
  51                 UDI_REGIONPRIO_LO,
  52                 UDI_REGIONPRIO_HI,
  53         }       Priority;
  54         enum {
  55                 UDI_REGIONLATENCY_NONOVERRRUNABLE,
  56                 UDI_REGIONLATENCY_POWERFAIL,
  57                 UDI_REGIONLATENCY_OVERRUNNABLE,
  58                 UDI_REGIONLATENCY_RETRYABLE,
  59                 // non_overrunable
  60                 UDI_REGIONLATENCY_NONCTRITICAL,
  61         }       Latency;
  62         udi_ubit32_t    OverrunTime;
  63
  64         udi_index_t     BindMeta;
  65         udi_index_t     PriBindOps;
  66         udi_index_t     SecBindOps;
  67         udi_index_t     BindCb;
  68 };
  69
  70 struct sUDI_MetaLang
  71 {
  72         const char *Name;
  73          int    nOpGroups;
  74         struct {
  75                 void    *OpList;
  76         } OpGroups;
  77          int    nCbTypes;
  78         struct {
  79                 size_t  Size;
  80                 udi_layout_t    *Layout;
  81         } CbTypes[];
  82 };
  83
  84 struct sUDI_MetaLangRef
  85 {
  86         udi_ubit8_t     meta_idx;
  87         const char      *interface_name;
  88         tUDI_MetaLang   *metalang;
  89         // TODO: pointer to metalanguage structure
  90 };
  91
  92 struct sUDI_BindOps
  93 {
  94         udi_ubit8_t     meta_idx;
  95         udi_ubit8_t     region_idx;
  96         udi_ubit8_t     ops_idx;
  97         udi_ubit8_t     bind_cb_idx;
  98 };
  99
 100 struct sUDI_PropDevSpec
 101 {
 102          int    MessageNum;
 103         udi_ubit8_t     MetaIdx;
 104         tUDI_MetaLang   *Metalang;
 105          int    nAttribs;
 106         udi_instance_attr_list_t        Attribs[];
 107 };
 108
 109 struct sUDI_DriverModule
 110 {
 111         tUDI_DriverModule       *Next;
 112         void    *Base;
 113
 114         udi_init_t      *InitInfo;
 115
 116         // Counts of arrays in InitInfo
 117          int    nCBInit;
 118          int    nOpsInit;
 119
 120         const char      *ModuleName;
 121          int    nMessages;
 122         tUDI_PropMessage        *Messages;      // Sorted list
 123
 124          int    nRegionTypes;
 125         tUDI_PropRegion *RegionTypes;
 126
 127          int    nMetaLangs;
 128         tUDI_MetaLangRef        *MetaLangs;
 129
 130          int    nParents;
 131         tUDI_BindOps    *Parents;
 132
 133          int    nChildBindOps;
 134         tUDI_BindOps    *ChildBindOps;
 135
 136          int    nDevices;
 137         tUDI_PropDevSpec        **Devices;
 138
 139          int    nRegions;
 140 };
 141
 142 struct sUDI_DriverInstance
 143 {
 144         struct sUDI_DriverInstance      *Next;
 145         tUDI_DriverModule       *Module;
 146         udi_channel_t   ManagementChannel;
 147         tUDI_ChildBinding       *FirstChild;
 148         tUDI_DriverRegion       *Regions[];
 149 };
 150
 151 struct sUDI_DriverRegion
 152 {
 153         udi_init_context_t      *InitContext;
 154 };
 155
 156 struct sUDI_ChildBinding
 157 {
 158         tUDI_ChildBinding       *Next;
 159
 160         udi_ubit32_t    ChildID;
 161         tUDI_MetaLang   *Metalang;
 162         tUDI_BindOps    *BindOps;
 163
 164         udi_ops_init_t  *Ops;
 165         tUDI_DriverInstance     *BoundInstance;
 166
 167          int    nAttribs;
 168         udi_instance_attr_list_t        Attribs[];
 169 };
 170
 171 // --- Metalanguages ---
 172 extern tUDI_MetaLang    cMetaLang_Management;
 173
 174
 175 // --- Index to pointer translation ---
 176 extern udi_ops_init_t   *UDI_int_GetOps(tUDI_DriverInstance *Inst, udi_index_t index);
 177 extern tUDI_MetaLang *UDI_int_GetMetaLang(tUDI_DriverInstance *Inst, udi_index_t meta_idx);
 178
 179 // --- Channels ---
 180 extern udi_channel_t    UDI_CreateChannel_Blank(tUDI_MetaLang *metalang);
 181 extern int      UDI_BindChannel_Raw(udi_channel_t channel, bool other_side, tUDI_DriverInstance *inst, udi_index_t meta_ops_num, void *context, const void *ops);
 182 extern int      UDI_BindChannel(udi_channel_t channel, bool other_side, tUDI_DriverInstance *inst, udi_index_t ops, udi_index_t region);
 183 extern tUDI_DriverInstance      *UDI_int_ChannelGetInstance(udi_cb_t *gcb, bool other_side);
 184 extern const void       *UDI_int_ChannelPrepForCall(udi_cb_t *gcb, tUDI_MetaLang *metalang, udi_index_t meta_ops_num);
 185 extern void     UDI_int_ChannelFlip(udi_cb_t *gcb);
 186 extern void     UDI_int_ChannelReleaseFromCall(udi_cb_t *gcb);
 187
 188 // --- Async Calls ---
 189 typedef struct sUDI_DeferredCall        tUDI_DeferredCall;
 190 typedef void    tUDI_DeferredUnmarshal(tUDI_DeferredCall *Call);
 191 struct sUDI_DeferredCall
 192 {
 193         struct sUDI_DeferredCall        *Next;
 194         tUDI_DeferredUnmarshal  *Unmarshal;
 195         udi_cb_t        *cb;
 196         udi_op_t        *Handler;
 197         // ...
 198 };
 199 extern void     UDI_int_DeferredThread(void *unused);   // Worker started by main.c
 200 extern void     UDI_int_AddDeferred(tUDI_DeferredCall *Call);
 201 extern void     UDI_int_MakeDeferredCb(udi_cb_t *cb, udi_op_t *handler);
 202 extern void     UDI_int_MakeDeferredCbU8(udi_cb_t *cb, udi_op_t *handler, udi_ubit8_t arg1);
 203 extern void     UDI_int_MakeDeferredCbS(udi_cb_t *cb, udi_op_t *handler, udi_status_t status);
 204
 205 // --- CBs ---
 206 extern void *udi_cb_alloc_internal(tUDI_DriverInstance *Inst, udi_ubit8_t bind_cb_idx, udi_channel_t channel);
 207
 208
 209 #endif
 210