KernelLand/Modules/Interfaces/UDI/include/udi.h

   1 /**
   2  * \file udi.h
   3  */
   4 #ifndef _UDI_H_
   5 #define _UDI_H_
   6
   7 #include <stdint.h>
   8 #include <stdarg.h>
   9
  10 typedef int8_t  udi_sbit8_t;    /* signed 8-bit: -2^7..2^7-1 */
  11 typedef int16_t udi_sbit16_t;   /* signed 16-bit: -2^15..2^15-1 */
  12 typedef int32_t udi_sbit32_t;   /* signed 32-bit: -2^31..2^31-1 */
  13 typedef uint8_t         udi_ubit8_t;    /* unsigned 8-bit: 0..28-1 */
  14 typedef uint16_t        udi_ubit16_t;   /* unsigned 16-bit: 0..216-1 */
  15 typedef uint32_t        udi_ubit32_t;   /* unsigned 32-bit: 0..232-1 */
  16
  17 #if UDI_ABI_is_ia32
  18 #include "udi/arch/x86.h"
  19 #else
  20 #error "Unknown UDI ABI"
  21 #endif
  22
  23 /**
  24  * \name Values and Flags for udi_status_t
  25  * \{
  26  */
  27 #define UDI_STATUS_CODE_MASK            0x0000FFFF
  28 #define UDI_STAT_META_SPECIFIC          0x00008000
  29 #define UDI_SPECIFIC_STATUS_MASK        0x00007FFF
  30 #define UDI_CORRELATE_OFFSET            16
  31 #define UDI_CORRELATE_MASK                      0xFFFF0000
  32 /* Common Status Values */
  33 #define UDI_OK                                          0
  34 #define UDI_STAT_NOT_SUPPORTED          1
  35 #define UDI_STAT_NOT_UNDERSTOOD         2
  36 #define UDI_STAT_INVALID_STATE          3
  37 #define UDI_STAT_MISTAKEN_IDENTITY      4
  38 #define UDI_STAT_ABORTED                        5
  39 #define UDI_STAT_TIMEOUT                        6
  40 #define UDI_STAT_BUSY                           7
  41 #define UDI_STAT_RESOURCE_UNAVAIL       8
  42 #define UDI_STAT_HW_PROBLEM                     9
  43 #define UDI_STAT_NOT_RESPONDING         10
  44 #define UDI_STAT_DATA_UNDERRUN          11
  45 #define UDI_STAT_DATA_OVERRUN           12
  46 #define UDI_STAT_DATA_ERROR                     13
  47 #define UDI_STAT_PARENT_DRV_ERROR       14
  48 #define UDI_STAT_CANNOT_BIND            15
  49 #define UDI_STAT_CANNOT_BIND_EXCL       16
  50 #define UDI_STAT_TOO_MANY_PARENTS       17
  51 #define UDI_STAT_BAD_PARENT_TYPE        18
  52 #define UDI_STAT_TERMINATED                     19
  53 #define UDI_STAT_ATTR_MISMATCH          20
  54 /**
  55  * \}
  56  */
  57
  58 /**
  59  * \name Data Layout Specifiers
  60  * \{
  61  */
  62 typedef const udi_ubit8_t       udi_layout_t;
  63 /* Specific-Length Layout Type Codes */
  64 #define UDI_DL_UBIT8_T                   1
  65 #define UDI_DL_SBIT8_T                   2
  66 #define UDI_DL_UBIT16_T                  3
  67 #define UDI_DL_SBIT16_T                  4
  68 #define UDI_DL_UBIT32_T                  5
  69 #define UDI_DL_SBIT32_T                  6
  70 #define UDI_DL_BOOLEAN_T                 7
  71 #define UDI_DL_STATUS_T                  8
  72 /* Abstract Element Layout Type Codes */
  73 #define UDI_DL_INDEX_T                   20
  74 /* Opaque Handle Element Layout Type Codes */
  75 #define UDI_DL_CHANNEL_T                 30
  76 #define UDI_DL_ORIGIN_T                  32
  77 /* Indirect Element Layout Type Codes */
  78 #define UDI_DL_BUF                       40
  79 #define UDI_DL_CB                        41
  80 #define UDI_DL_INLINE_UNTYPED            42
  81 #define UDI_DL_INLINE_DRIVER_TYPED       43
  82 #define UDI_DL_MOVABLE_UNTYPED           44
  83 /* Nested Element Layout Type Codes */
  84 #define UDI_DL_INLINE_TYPED              50
  85 #define UDI_DL_MOVABLE_TYPED             51
  86 #define UDI_DL_ARRAY                     52
  87 #define UDI_DL_END                       0
  88 /**
  89  * \}
  90  */
  91
  92
  93 typedef struct udi_init_s               udi_init_t;
  94 typedef struct udi_primary_init_s       udi_primary_init_t;
  95 typedef struct udi_secondary_init_s     udi_secondary_init_t;
  96 typedef struct udi_ops_init_s   udi_ops_init_t;
  97 typedef struct udi_cb_init_s    udi_cb_init_t;
  98 typedef struct udi_cb_select_s  udi_cb_select_t;
  99 typedef struct udi_gcb_init_s   udi_gcb_init_t;
 100
 101 typedef struct udi_init_context_s       udi_init_context_t;
 102 typedef struct udi_limits_s             udi_limits_t;
 103 typedef struct udi_chan_context_s       udi_chan_context_t;
 104 typedef struct udi_child_chan_context_s udi_child_chan_context_t;
 105
 106 typedef void    udi_op_t(void);
 107 typedef udi_op_t * const        udi_ops_vector_t;
 108
 109 // === INCLUDE SUB-SECTIONS ===
 110 #include "udi/cb.h"     // Control Blocks
 111 #include "udi/time.h"   // Timer Services
 112 #include "udi/log.h"    // Logging
 113 #include "udi/attr.h"   // Attributes
 114 #include "udi/strmem.h" // String/Memory
 115 #include "udi/queues.h" // Queues
 116 #include "udi/buf.h"    // Buffers
 117 #include "udi/mem.h"    // Memory Management
 118 #include "udi/imc.h"    // Inter-module Communication
 119 #include "udi/meta_mgmt.h"      // Management Metalanguage
 120 #include "udi/meta_gio.h"       // General IO Metalanguage
 121 #include "udi/init.h"   // Init
 122
 123 #endif