3 * Contains the graphics metalanguage interface details
12 * http://www.d-rift.nl/combuster/mos3/?p=viewsource&file=/include/common/udi_gfx.h
15 // note that the specification, and thus, the contents of this file is not fixed.
22 #ifndef UDI_GFX_VERSION
23 #error "UDI_GFX_VERSION not defined."
24 #elif UDI_GFX_VERSION != 0x101
25 #error "UDI_GFX_VERSION not supported."
29 * Enumeration: UDI_GFX_PROP
30 * Lists the various UDI properties
33 // General state properties
34 /* Constant: UDI_GFX_PROP_ENABLE
42 * Must include at least 1
44 * The primary state of the connector or engine. An enabled state indicates
45 * it is functioning and generating live output. A disabled state is one where
46 * it is not contributing to any output but is otherwise functional. Finally
47 * the reset state is where the driver is free to deallocate all resources
48 * corresponding to this component and trash any state not referenced by other
51 * A disabled or reset engine forwards all data from the previous stage
52 * unmodified. The disabled state indicates that the component might be
53 * returned to its enabled state within short notice.
55 * A disabled connector will not send pixel data, but can perform other
56 * initialisation communication such as DDC. A reset connector will not respond
57 * in any fashion and can not be used for other purposes. Hardware is expected
58 * to be powered down in such state.
60 * Users should expect significant delays when moving components in and out of
61 * the reset state. Moving engines between the enabled and disabled state should
62 * take effect within one frame, such transition should take effect on a frame
63 * boundary when supported.
65 #define UDI_GFX_PROP_ENABLE 0
67 #define UDI_GFX_PROP_ENABLE_DISABLED 0
68 #define UDI_GFX_PROP_ENABLE_ENABLED 1
69 #define UDI_GFX_PROP_ENABLE_RESET 2
70 /* Constant: UDI_GFX_PROP_INPUT
73 * Any valid engine ID, provided no dependency cycles are created, or -1
76 * Any non-empty set of valid values. Often hardwired.
78 * Points to the engine that is processed before this unit. In the case of a
79 * connector, it points to the last engine in a pipeline, and each engine points
80 * to the next engine in the sequence. A value of -1 indicates a source that
81 * only yields black pixels. Implementations must not allow cyclic structures.
82 * Changing this value may reallocate resources, and engines that are no longer
83 * referenced may lose their data (but not their state) when it is not part of
84 * any pipeline. If preservation is required, the ENABLE state should be used
85 * instead. Valid ranges includes one or more from the list of engines and -1
86 * combined. In most cases, this property can not be modified.
88 #define UDI_GFX_PROP_INPUT 1
89 /* Constant: UDI_GFX_PROP_WIDTH
92 * Any non-zero positive number.
95 * Contains at least one valid value. Often only multiples of UNIT_WIDTH
96 * or a power of two are allowed. May be hardwired.
98 * Contains the amount of pixels in the horizontal direction. For connectors,
99 * this is the amount of data pixels rendered horizontally. For engines, this
100 * is the width in pixels of the image. Pixels requested from an engine outside
101 * the range (0..width-1) are defined according to the <UDI_GFX_PROP_CLIP>
102 * property. In some cases, hardware may support only fixed combinations of
103 * width and height. In such cases, changing the width will also change the
104 * height to a corresponding valid number. Valid ranges include any values
105 * strictly above zero. For connectors, expect large continuous ranges, large
106 * ranges with a certain modulus, a limited number of fixed values, or a
109 #define UDI_GFX_PROP_WIDTH 2
110 /* Constant: UDI_GFX_PROP_HEIGHT
113 * Any non-zero positive number.
116 * Contains at least one valid value. Often only multiples of UNIT_HEIGHT
117 * or a power of two are allowed. May be hardwired.
119 * Contains the amount of pixels in the vertical direction. Functions similar
120 * to the width property, but changing it will not alter the width property,
121 * and it's range at any time contains the valid range for the currently
124 #define UDI_GFX_PROP_HEIGHT 3
126 /* Constant: UDI_GFX_PROP_CUSTOM
127 * The first property index of the driver's custom range. These are not assigned
128 * directly assigned by the UDI specification, but may be specified in the
131 #define UDI_GFX_PROP_CUSTOM 1024
135 /* Constant: UDI_GFX_PROP_CLIP
138 * 0 - points outside width x height are passed unmodified from input
139 * 1 - the engine's contents is tiled with size width x height
140 * 2 - points outside the width overflow into the y coordinate
141 * 3 - points outside the height overflow into the x coordinate
144 * Hardwired zero for connectors. Any non-empty subset for engines, usually
147 * For engines, contains the behaviour for pixels requested outside the width
148 * and height of the engine. Can be either 0 (pass from next stage), 1 (the
149 * coordinates are wrapped modulus the height and width), 2 (the coordinates
150 * overflow onto the next scanline horizontally, and wrap vertically), 3 (the
151 * coordinates overflow onto the next column vertically, and wrap horizontally).
152 * Valid ranges contain one or more of these options. For overlays and sprites,
153 * a value 0 is common. For framebuffers, 2 is the most common value. For
154 * connectors, this property is always 0 since they do not store pixel data
156 #define UDI_GFX_PROP_CLIP 4
158 /* Constant: UDI_GFX_PROP_UNIT_WIDTH
161 * Any non-zero positive value
164 * Any non-empty set of valid values. May be hardwired to 1 for
165 * framebuffers, or a range of small values for hardware scaling, or any
166 * larger hardwired number or set for tiling engines.
168 * Tiles are used to indicate that the hardware groups sets of pixels and have
169 * each group share certain properties, i.e. color or tile index, or share the
170 * same chroma subsample with only a different intensity. If the engine has no
171 * such grouping, or shares all properties over the entire contents, the value
172 * of this property should be 1. Some tile examples include rescaling, where a
173 * tile width of 2 indicates a pixel doubling in X direction, or in text mode
174 * where a tile width of 8 or 9 corresponds with the width of common bitmap
177 #define UDI_GFX_PROP_UNIT_WIDTH 5
179 /* Constant: UDI_GFX_PROP_UNIT_HEIGHT
182 * Any non-zero positive value
185 * Any non-empty set of valid values. May be hardwired to 1 for
186 * framebuffers, or a range of small values for hardware scaling, or any
187 * larger hardwired number or set for tiling engines.
189 * See <UDI_GFX_PROP_UNIT_WIDTH>, but for the Y direction. Common values are
190 * 1-2 for framebuffers (doublescanning on or off), identical to the tile
191 * width, or mostly independent.
193 #define UDI_GFX_PROP_UNIT_HEIGHT 6
195 /* Constant: UDI_GFX_PROP_TRANSLATEX
201 * Any non-empty set. Typical values are hardwired zero, continuous
202 * between -WIDTH and WIDTH, -WIDTH to zero inclusive, or all possible values
204 * The horizontal offset where drawing starts. A positive value means the top-left
205 * corner moves towards the right end of the screen, a negative value moves the
206 * origin off the screen on the left side. Clipped areas moved off the screen do
207 * not reappear on the opposite side.
209 * With clipping enabled, this field combined with <UDI_GFX_PROP_WIDTH>
210 * determines the area where the image should be drawn, which is the horizontal
211 * range from UDI_GFX_PROP_TRANSLATEX to UDI_GFX_PROP_WIDTH +
212 * UDI_GFX_PROP_TRANSLATEX - 1
214 #define UDI_GFX_PROP_TRANSLATEX 7
216 /* Constant: UDI_GFX_PROP_TRANSLATEY
222 * Any non-empty set. Typical values are hardwired zero, continuous
223 * between -WIDTH and WIDTH, or all possible values
225 * See <UDI_GFX_PROP_TRANSLATEX> but for the Y direction.
227 #define UDI_GFX_PROP_TRANSLATEY 8
229 #define UDI_GFX_PROP_GL_VERSION 14
230 #define UDI_GFX_PROP_GLES_VERSION 15
231 #define UDI_GFX_PROP_STATE_BLOCK 16
232 #define UDI_GFX_PROP_COLOR_BITS 22
233 #define UDI_GFX_PROP_GL_TARGET 23
235 /* Constant: UDI_GFX_PROP_STOCK_FORMAT
238 * Zero, or any constant from <UDI_GFX_STOCK_FORMAT>
241 * Any non-empty set of valid values.
243 * This field indicates the storage format is one from a limited set of
244 * typical configurations. If the field is zero, the engine is not knowingly
245 * configured as a common framebuffer. If nonzero, the operator chain and any
246 * dependent settings are defined to be functionally equivalent to that of a
247 * typical framebuffer device.
249 * The value zero does not imply that the device does not actually follow a
250 * set convention. This saves drivers from writing elaborate checking code
251 * to determine the condition in question.
253 * Writing this field potentially modifies other property fields within the
254 * same engine to establish the requested configuration. Manually writing such
255 * properties after changing this setting may in turn revert this property to
256 * the zero state, even if there was no modification or the behaviour is still
257 * as previously advertised by this property.
259 #define UDI_GFX_PROP_STOCK_FORMAT 27
261 /* Constant: UDI_GFX_PROP_OPERATOR_COUNT
264 * Any non-zero positive number
267 * Most likely constant. Can be any set of valid values.
269 * The current value is the number of entries in the operator tree that can
270 * be requested for this engine using <udi_gfx_get_engine_operator_req> and
271 * <udi_gfx_get_engine_operator_ack>
273 #define UDI_GFX_PROP_OPERATOR_COUNT 28
275 // properties for removal:
276 #define UDI_GFX_PROP_STORE_COUNT 24 // not generic
277 #define UDI_GFX_PROP_STORE_WIDTH 9 // not generic
278 #define UDI_GFX_PROP_STORE_HEIGHT 10 // not generic
279 #define UDI_GFX_PROP_STORE_BITS 11 // not generic
280 #define UDI_GFX_PROP_PALETTE 1024 // optional, can be derived from the operator tree
281 #define UDI_GFX_PROP_BUFFER 1025 // optional, can be derived from the operator tree
282 #define UDI_GFX_PROP_TILESHEET 1026 // optional, can be derived from the operator tree
283 #define UDI_GFX_PROP_OPERATOR_INDEX 17 // deprecated for dedicated methods
284 #define UDI_GFX_PROP_OPERATOR_OPCODE 18 // deprecated for dedicated methods
285 #define UDI_GFX_PROP_OPERATOR_ARG_1 19 // deprecated for dedicated methods
286 #define UDI_GFX_PROP_OPERATOR_ARG_2 20 // deprecated for dedicated methods
287 #define UDI_GFX_PROP_OPERATOR_ARG_3 21 // deprecated for dedicated methods
288 #define UDI_GFX_PROP_SOURCE_WIDTH 12 // should have been documented when I still knew what it did.
289 #define UDI_GFX_PROP_SOURCE_HEIGHT 13 // should have been documented when I still knew what it did.
290 #define UDI_GFX_PROP_INPUTX 25 // should have been documented when I still knew what it did.
291 #define UDI_GFX_PROP_INPUTY 26 // should have been documented when I still knew what it did.
293 // connector properties
294 #define UDI_GFX_PROP_SIGNAL 23
295 #define UDI_GFX_PROP_CONNECTOR_TYPE 24
296 #define UDI_GFX_PROP_VGA_H_FRONT_PORCH 25
297 #define UDI_GFX_PROP_VGA_H_BACK_PORCH 26
298 #define UDI_GFX_PROP_VGA_H_SYNC 27
299 #define UDI_GFX_PROP_VGA_V_FRONT_PORCH 28
300 #define UDI_GFX_PROP_VGA_V_BACK_PORCH 29
301 #define UDI_GFX_PROP_VGA_V_SYNC 30
302 #define UDI_GFX_PROP_DOT_CLOCK 31
303 #define UDI_GFX_PROP_VGA_H_SYNC_POL 32
304 #define UDI_GFX_PROP_VGA_V_SYNC_POL 33
307 * Enumeration: UDI_GFX_SIGNAL
308 * Lists the various signal types
310 #define UDI_GFX_SIGNAL_HIDDEN 0
311 #define UDI_GFX_SIGNAL_INTEGRATED 0
312 #define UDI_GFX_SIGNAL_RGBHV 1
313 #define UDI_GFX_SIGNAL_RGBS 2
314 #define UDI_GFX_SIGNAL_RGSB 3
315 #define UDI_GFX_SIGNAL_YPBPR 4
316 #define UDI_GFX_SIGNAL_DVID 5
317 #define UDI_GFX_SIGNAL_YUV 6
318 #define UDI_GFX_SIGNAL_YIQ 7
319 #define UDI_GFX_SIGNAL_Y_UV 8
320 #define UDI_GFX_SIGNAL_Y_IQ 9
321 #define UDI_GFX_SIGNAL_HDMI 10
322 #define UDI_GFX_SIGNAL_TEXT 11
323 #define UDI_GFX_SIGNAL_CUSTOM 12
326 * Enumeration: UDI_GFX_CONNECTOR
327 * Lists the various external connectors
329 #define UDI_GFX_CONNECTOR_HIDDEN 0
330 #define UDI_GFX_CONNECTOR_VGA 1
331 #define UDI_GFX_CONNECTOR_DVI 2
332 #define UDI_GFX_CONNECTOR_SVIDEO 3
333 #define UDI_GFX_CONNECTOR_COMPONENT 4
334 #define UDI_GFX_CONNECTOR_HDMI 5
335 #define UDI_GFX_CONNECTOR_RF 6
336 #define UDI_GFX_CONNECTOR_SCART 7
337 #define UDI_GFX_CONNECTOR_COMPOSITE 8
338 #define UDI_GFX_CONNECTOR_MEMBUFFER 9
341 * Enumeration: UDI_GFX_OPERATOR
342 * Lists the display output operator
344 * a1/a2/a3 represents taking the output of a previous operation
345 * v1/v2/v3 represents the literal value of that argument
347 #define UDI_GFX_OPERATOR_RGB 0 // output = (color) red(a1) + green(a2) + blue(a3) (each component is UDI_GFX_PROP_COLOR_BITS
348 #define UDI_GFX_OPERATOR_YUV 1 // output = (color) Y(a1) + U(a2) + V(a3)
349 #define UDI_GFX_OPERATOR_YIQ 2 // output = (color) Y(a1) + I(a2) + Q(a3)
350 #define UDI_GFX_OPERATOR_I 3 // output = (color) intensity(a1)
351 #define UDI_GFX_OPERATOR_ALPHA 4 // output = (color) a1 + alpha(a2)
352 #define UDI_GFX_OPERATOR_ADD 5 // output = a1 + a2 + v3
353 #define UDI_GFX_OPERATOR_SUB 6 // output = a1 - a2 - v3
354 #define UDI_GFX_OPERATOR_MUL 7 // output = a1 * a2
355 #define UDI_GFX_OPERATOR_DIV 8 // output = a1 / a2
356 #define UDI_GFX_OPERATOR_MAD 9 // output = a1 * a2 + a3
357 #define UDI_GFX_OPERATOR_FRC 10 // output = (a1 * a2) / a3
358 #define UDI_GFX_OPERATOR_SHR 11 // output = a1 >> (a2 + v3)
359 #define UDI_GFX_OPERATOR_SHL 12 // output = a1 << (a2 + v3)
360 #define UDI_GFX_OPERATOR_ROR 13 // output = a1 >> a2 (over a3 bits)
361 #define UDI_GFX_OPERATOR_ROL 14 // output = a1 << a2 (over a3 bits)
362 #define UDI_GFX_OPERATOR_SAR 15 // output = a1 >> a2 (width is a3 bits, i.e. empties are filled with bit a3-1)
363 #define UDI_GFX_OPERATOR_SAL 16 // output = a1 <<< (a2 + v3) (empties filled with bit 0)
364 #define UDI_GFX_OPERATOR_AND 17 // output = a1 & a2
365 #define UDI_GFX_OPERATOR_OR 18 // output = a1 | a2 | v3
366 #define UDI_GFX_OPERATOR_NOT 19 // output = ~a1
367 #define UDI_GFX_OPERATOR_XOR 20 // output = a1 ^ a2 ^ v3
368 #define UDI_GFX_OPERATOR_NEG 21 // output = -a1
369 #define UDI_GFX_OPERATOR_SEG 22 // output = (a1 >> v2) & (2**v3-1) (select v3 bits starting from bit v2)
370 #define UDI_GFX_OPERATOR_RANGE 23 // output = (a1 > a2) ? a2 : ((a1 < a3) ? a3 : a1)
371 #define UDI_GFX_OPERATOR_CONST 24 // output = v1
372 #define UDI_GFX_OPERATOR_ATTR 25 // output = property[a1 + v2]
373 #define UDI_GFX_OPERATOR_SWITCH 26 // output = output[(a1 % v3) + v2]
374 #define UDI_GFX_OPERATOR_BUFFER 27 // output = buffer[a1][a2] (buffer is v3 bits per entry)
375 #define UDI_GFX_OPERATOR_X 28 // output = output x pixel
376 #define UDI_GFX_OPERATOR_Y 29 // output = output y pixel
377 #define UDI_GFX_OPERATOR_TX 30 // output = horizontal tile index belonging to output pixel
378 #define UDI_GFX_OPERATOR_TY 31 // output = vertical tile index belonging to output pixel
379 #define UDI_GFX_OPERATOR_TXOFF 32 // output = horizontal offset from start of tile
380 #define UDI_GFX_OPERATOR_TYOFF 33 // output = vertical offset from start of tile
381 #define UDI_GFX_OPERATOR_INPUT 34 // output = input engine[x][y] component v1
382 #define UDI_GFX_OPERATOR_DINPUT 35 // output = input engine[a1][a2] component v3
384 /* Enumeration: UDI_GFX_STOCK_FORMAT
385 * Lists stock configurations
387 * When a stock configuration is used, the device is set to behave as a
388 * simple framebuffer device. The <UDI_GFX_PROP_WIDTH> and <UDI_GFX_PROP_HEIGHT>
389 * determine the virtual size of the framebuffer, and <UDI_GFX_PROP_TRANSLATEX>
390 * and <UDI_GFX_PROP_TRANSLATEY> indicate the offset into that framebuffer
391 * that is visible (which are typically restricted to negative values)
393 #define UDI_GFX_STOCK_FORMAT_UNKNOWN 0
394 #define UDI_GFX_STOCK_FORMAT_R8G8B8X8 1
395 #define UDI_GFX_STOCK_FORMAT_B8G8R8X8 2
396 #define UDI_GFX_STOCK_FORMAT_R8G8B8 3
397 #define UDI_GFX_STOCK_FORMAT_B8G8R8 4
398 #define UDI_GFX_STOCK_FORMAT_R5G6B5 5
399 #define UDI_GFX_STOCK_FORMAT_B5G6R5 6
400 #define UDI_GFX_STOCK_FORMAT_R5G5B5X1 7
401 #define UDI_GFX_STOCK_FORMAT_B5G5R5X1 8
402 #define UDI_GFX_STOCK_FORMAT_N8 9
404 // Enumeration: UDI_GFX_BUFFER_INFO_FLAG
405 // Lists behavioural patterns for direct buffer accesses.
407 #define UDI_GFX_BUFFER_INFO_FLAG_R 0x0001 // buffer can be read
408 #define UDI_GFX_BUFFER_INFO_FLAG_W 0x0002 // buffer can be written
409 #define UDI_GFX_BUFFER_INFO_FLAG_BITALIGN_ENTRY 0x0004 // for non-multiple-of-eight buffer slot sizes, align on byte boundary every unit
410 #define UDI_GFX_BUFFER_INFO_FLAG_BITALIGN_ROW 0x0008 // for non-multiple-of-eight buffer slot sizes, align only the start of the row
413 // Constant: UDI_GFX_PROVIDER_OPS_NUM
414 // the ops number used for the graphics driver
415 #define UDI_GFX_PROVIDER_OPS_NUM 1
417 // Constant: UDI_GFX_CLIENT_OPS_NUM
418 // the ops number used for the graphics application
419 #define UDI_GFX_CLIENT_OPS_NUM 2
421 // Structure: udi_gfx_bind_cb_t
422 // Contains the operations of a driver binding request
425 // The main control block
428 #define UDI_GFX_BIND_CB_NUM 1
430 // Function: udi_block_bind_req
431 // function pointer prototype for connecting to a block device
434 // cb - A pointer to a <udi_block_bind_cb_t>
436 typedef void udi_gfx_bind_req_op_t (udi_gfx_bind_cb_t *cb );
437 udi_gfx_bind_req_op_t udi_gfx_bind_req;
439 // Function: udi_gfx_bind_ack
440 // function pointer prototype for acknowledging a connection request
443 // cb - A pointer to a <udi_gfx_bind_cb_t>
444 // sockets - The number of addressable socket components
445 // engines - The number of addressable engine components
446 // status - The result of the bind operation
448 typedef void udi_gfx_bind_ack_op_t (udi_gfx_bind_cb_t *cb, udi_index_t sockets, udi_index_t engines, udi_status_t status );
449 udi_gfx_bind_ack_op_t udi_gfx_bind_ack;
451 // Function: udi_gfx_unbind_req
452 // function pointer prototype for disconnecting a block device
455 // cb - A pointer to a <udi_block_bind_cb_t>
457 typedef void udi_gfx_unbind_req_op_t (udi_gfx_bind_cb_t *cb );
458 udi_gfx_unbind_req_op_t udi_gfx_unbind_req;
460 // Function: udi_gfx_unbind_ack
461 // function pointer prototype for connecting to a block device
464 // cb - A pointer to a <udi_gfx_bind_cb_t>
466 typedef void udi_gfx_unbind_ack_op_t (udi_gfx_bind_cb_t *cb );
467 udi_gfx_unbind_ack_op_t udi_gfx_unbind_ack;
469 // Structure: udi_gfx_state_cb_t
470 // Contains the operations of a read/write transaction
473 // The main control block
475 udi_ubit32_t subsystem;
476 udi_ubit32_t attribute;
477 } udi_gfx_state_cb_t;
478 #define UDI_GFX_STATE_CB_NUM 2
480 // Function: udi_gfx_set_engine_req
481 // function pointer prototype for setting an engine state
484 // cb - A pointer to a <udi_gfx_state_cb_t>
486 typedef void udi_gfx_set_engine_req_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t value);
487 udi_gfx_set_engine_req_op_t udi_gfx_set_engine_req;
489 // Function: udi_gfx_set_connector_req
490 // function pointer prototype for setting an connector state
493 // cb - A pointer to a <udi_gfx_state_cb_t>
495 typedef void udi_gfx_set_connector_req_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t value);
496 udi_gfx_set_connector_req_op_t udi_gfx_set_connector_req;
498 // Function: udi_gfx_set_engine_ack
499 // function pointer prototype for setting an engine state
502 // cb - A pointer to a <udi_gfx_state_cb_t>
504 typedef void udi_gfx_set_engine_ack_op_t (udi_gfx_state_cb_t *cb );
505 udi_gfx_set_engine_ack_op_t udi_gfx_set_engine_ack;
507 // Function: udi_gfx_set_connector_ack
508 // function pointer prototype for setting an engine state
511 // cb - A pointer to a <udi_gfx_state_cb_t>
513 typedef void udi_gfx_set_connector_ack_op_t (udi_gfx_state_cb_t *cb );
514 udi_gfx_set_connector_ack_op_t udi_gfx_set_connector_ack;
516 // Function: udi_gfx_get_engine_req
517 // function pointer prototype for setting an engine state
520 // cb - A pointer to a <udi_gfx_state_cb_t>
522 typedef void udi_gfx_get_engine_req_op_t (udi_gfx_state_cb_t *cb );
523 udi_gfx_get_engine_req_op_t udi_gfx_get_engine_req;
525 // Function: udi_gfx_get_connector_req
526 // function pointer prototype for setting an connector state
529 // cb - A pointer to a <udi_gfx_state_cb_t>
531 typedef void udi_gfx_get_connector_req_op_t (udi_gfx_state_cb_t *cb );
532 udi_gfx_get_connector_req_op_t udi_gfx_get_connector_req;
534 // Function: udi_gfx_get_engine_ack
535 // function pointer prototype for setting an engine state
538 // cb - A pointer to a <udi_gfx_state_cb_t>
540 typedef void udi_gfx_get_engine_ack_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t value);
541 udi_gfx_get_engine_ack_op_t udi_gfx_get_engine_ack;
543 // Function: udi_gfx_get_connector_ack
544 // function pointer prototype for setting an engine state
547 // cb - A pointer to a <udi_gfx_state_cb_t>
549 typedef void udi_gfx_get_connector_ack_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t value);
550 udi_gfx_get_connector_ack_op_t udi_gfx_get_connector_ack;
552 // Function: udi_gfx_set_engine_nak
553 // function pointer prototype for setting an engine state
556 // cb - A pointer to a <udi_gfx_state_cb_t>
557 // status - An UDI status value indicative of the error
559 typedef void udi_gfx_set_engine_nak_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t status);
560 udi_gfx_set_engine_nak_op_t udi_gfx_set_engine_nak;
562 // Function: udi_gfx_set_connector_nak
563 // function pointer prototype for setting an engine state
566 // cb - A pointer to a <udi_gfx_state_cb_t>
567 // status - An UDI status value indicative of the error
569 typedef void udi_gfx_set_connector_nak_op_t (udi_gfx_state_cb_t *cb, udi_ubit32_t status);
570 udi_gfx_set_connector_nak_op_t udi_gfx_get_connector_nak;
572 // Structure: udi_gfx_range_cb_t
573 // Contains the operations of a range request transaction
576 // The main control block
578 udi_ubit32_t subsystem;
579 udi_ubit32_t attribute;
580 udi_buf_t * rangedata;
581 } udi_gfx_range_cb_t;
582 #define UDI_GFX_RANGE_CB_NUM 3
584 // Function: udi_gfx_range_engine_req
585 // function pointer prototype for getting an engine property range
588 // cb - A pointer to a <udi_gfx_range_cb_t>
590 typedef void udi_gfx_range_engine_req_op_t (udi_gfx_range_cb_t *cb );
591 udi_gfx_range_engine_req_op_t udi_gfx_range_engine_req;
593 // Function: udi_gfx_range_connector_req
594 // function pointer prototype for getting a connector property range
597 // cb - A pointer to a <udi_gfx_range_cb_t>
599 typedef void udi_gfx_range_connector_req_op_t (udi_gfx_range_cb_t *cb );
600 udi_gfx_range_connector_req_op_t udi_gfx_range_connector_req;
602 // Function: udi_gfx_range_engine_ack
603 // function pointer prototype for replying an engine property range
606 // cb - A pointer to a <udi_gfx_range_cb_t>
608 typedef void udi_gfx_range_engine_ack_op_t (udi_gfx_range_cb_t *cb );
609 udi_gfx_range_engine_ack_op_t udi_gfx_range_engine_ack;
611 // Function: udi_gfx_range_connector_ack
612 // function pointer prototype for replying a connector property range
615 // cb - A pointer to a <udi_gfx_range_cb_t>
617 typedef void udi_gfx_range_connector_ack_op_t (udi_gfx_range_cb_t *cb );
618 udi_gfx_range_connector_ack_op_t udi_gfx_range_connector_ack;
620 // Function: udi_gfx_get_engine_operator_req
621 // function pointer prototype for requesting the engine operator layout
624 // cb - A pointer to a <udi_gfx_state_cb_t>
626 typedef void udi_gfx_get_engine_operator_req_op_t (udi_gfx_range_cb_t *cb );
627 udi_gfx_get_engine_operator_req_op_t udi_gfx_get_engine_operator_req;
629 // Function: udi_gfx_get_engine_operator_ack
630 // function pointer prototype for replying the engine operator layout
633 // cb - A pointer to a <udi_gfx_state_cb_t>
634 // op - The operator performed at this index
635 // arg1 - the first argument to this operator
636 // arg2 - the second argument to this operator
637 // arg3 - the third argument to this operator
639 typedef void udi_gfx_get_engine_operator_ack_op_t (udi_gfx_range_cb_t *cb, udi_ubit32_t op, udi_ubit32_t arg1, udi_ubit32_t arg2, udi_ubit32_t arg3 );
640 udi_gfx_get_engine_operator_ack_op_t udi_gfx_get_engine_operator_ack;
644 // Structure: udi_gfx_command_cb_t
645 // Contains the operations of a command sequence
648 // The main control block
650 udi_buf_t * commanddata;
651 } udi_gfx_command_cb_t;
652 #define UDI_GFX_COMMAND_CB_NUM 4
654 // Function: udi_gfx_connector_command_req
655 // function pointer prototype for sending command data to the output connector
658 // cb - A pointer to a <udi_gfx_command_cb_t>
660 typedef void udi_gfx_connector_command_req_op_t (udi_gfx_command_cb_t *cb );
661 udi_gfx_connector_command_req_op_t udi_gfx_connector_command_req;
663 // Function: udi_gfx_engine_command_req
664 // function pointer prototype for sending command data to the engine
667 // cb - A pointer to a <udi_gfx_command_cb_t>
669 typedef void udi_gfx_engine_command_req_op_t (udi_gfx_command_cb_t *cb );
670 udi_gfx_engine_command_req_op_t udi_gfx_engine_command_req;
672 // Function: udi_gfx_connector_command_ack
673 // function pointer prototype for sending command data replies
676 // cb - A pointer to a <udi_gfx_command_cb_t>
678 typedef void udi_gfx_connector_command_ack_op_t (udi_gfx_command_cb_t *cb);
679 udi_gfx_connector_command_ack_op_t udi_gfx_connector_command_ack;
681 // Function: udi_gfx_engine_command_ack
682 // function pointer prototype for sending engine data replies
685 // cb - A pointer to a <udi_gfx_command_cb_t>
687 typedef void udi_gfx_engine_command_ack_op_t (udi_gfx_command_cb_t *cb);
688 udi_gfx_engine_command_ack_op_t udi_gfx_engine_command_ack;
690 // Structure: udi_gfx_buffer_cb_t
691 // Contains a description of a buffer, or area thereof
694 // The main control block
696 udi_ubit32_t buffer_index;
697 } udi_gfx_buffer_info_cb_t;
699 // Function: udi_gfx_buffer_info_req
700 // function pointer prototype for getting buffer configuration information
703 // cb - A pointer to a <udi_gfx_command_cb_t>
705 typedef void udi_gfx_buffer_info_req_op_t (udi_gfx_buffer_info_cb_t *cb);
706 udi_gfx_buffer_info_req_op_t udi_gfx_buffer_info_req;
708 // Function: udi_gfx_buffer_info_ack
709 // function pointer prototype for getting buffer configuration information
712 // cb - A pointer to a <udi_gfx_command_cb_t>
713 // width - The width of the buffer
714 // height - The height of the buffer
715 // bitsper - The number of bits read from the buffer per pixel unit
716 // flags - A bitfield of <UDI_GFX_BUFFER_FLAGS> indicating the exposed
717 // capabilities of this buffer
719 // Note that bitsper might not be a multiple of eight.
721 typedef void udi_gfx_buffer_info_ack_op_t (udi_gfx_buffer_info_cb_t *cb, udi_ubit32_t width, udi_ubit32_t height, udi_ubit32_t bitsper, udi_ubit32_t flags);
722 udi_gfx_buffer_info_ack_op_t udi_gfx_buffer_info_ack;
724 // Structure: udi_gfx_buffer_cb_t
725 // Contains a description of a buffer, or area thereof
728 // The main control block
730 udi_ubit32_t buffer_index;
736 } udi_gfx_buffer_cb_t;
738 // Function: udi_gfx_buffer_write_req_op_t
739 // function pointer prototype for writing raw hardware buffers
742 // cb - A pointer to a <udi_gfx_buffer_cb_t>
744 typedef void udi_gfx_buffer_write_req_op_t (udi_gfx_buffer_cb_t *cb);
745 udi_gfx_buffer_write_req_op_t udi_gfx_buffer_write_req;
747 // Function: udi_gfx_buffer_write_req_op_t
748 // function pointer prototype for reading raw hardware buffers
751 // cb - A pointer to a <udi_gfx_buffer_cb_t>
753 typedef void udi_gfx_buffer_read_req_op_t (udi_gfx_buffer_cb_t *cb);
754 udi_gfx_buffer_read_req_op_t udi_gfx_buffer_read_req;
756 // Function: udi_gfx_buffer_write_ack_op_t
757 // function pointer prototype for writing raw hardware buffers
760 // cb - A pointer to a <udi_gfx_buffer_cb_t>
762 typedef void udi_gfx_buffer_write_ack_op_t (udi_gfx_buffer_cb_t *cb);
763 udi_gfx_buffer_write_ack_op_t udi_gfx_buffer_write_ack;
765 // Function: udi_gfx_buffer_write_ack_op_t
766 // function pointer prototype for reading raw hardware buffers
769 // cb - A pointer to a <udi_gfx_buffer_cb_t>
771 typedef void udi_gfx_buffer_read_ack_op_t (udi_gfx_buffer_cb_t *cb);
772 udi_gfx_buffer_read_ack_op_t udi_gfx_buffer_read_ack;
774 // Function: udi_gfx_buffer_write_nak_op_t
775 // error handling for buffer writes
778 // cb - A pointer to a <udi_gfx_buffer_cb_t>
780 typedef void udi_gfx_buffer_write_nak_op_t (udi_gfx_buffer_cb_t *cb, udi_ubit32_t status);
781 udi_gfx_buffer_write_nak_op_t udi_gfx_buffer_write_nak;
783 // Function: udi_gfx_buffer_write_nak_op_t
784 // error handling for buffer reads
787 // cb - A pointer to a <udi_gfx_buffer_cb_t>
789 typedef void udi_gfx_buffer_read_nak_op_t (udi_gfx_buffer_cb_t *cb, udi_ubit32_t status);
790 udi_gfx_buffer_read_nak_op_t udi_gfx_buffer_read_nak;
792 /* Structure: udi_gfx_provider_ops_t
794 * The graphics metalanguage entry points (provider side)
796 typedef const struct {
797 udi_channel_event_ind_op_t *channel_event_ind_op;
798 udi_gfx_bind_req_op_t *gfx_bind_req_op;
799 udi_gfx_unbind_req_op_t *gfx_unbind_req_op;
800 udi_gfx_set_connector_req_op_t *gfx_set_connector_req_op;
801 udi_gfx_set_engine_req_op_t *gfx_set_engine_req_op;
802 udi_gfx_get_connector_req_op_t *gfx_get_connector_req_op;
803 udi_gfx_get_engine_req_op_t *gfx_get_engine_req_op;
804 udi_gfx_range_connector_req_op_t *gfx_range_connector_req_op;
805 udi_gfx_range_engine_req_op_t *gfx_range_engine_req_op;
806 udi_gfx_get_engine_operator_req_op_t*gfx_get_engine_operator_req_op_t;
807 udi_gfx_connector_command_req_op_t *gfx_connector_command_op;
808 udi_gfx_engine_command_req_op_t *gfx_engine_command_op;
809 udi_gfx_buffer_info_req_op_t *gfx_buffer_info_ack;
810 udi_gfx_buffer_read_req_op_t *gfx_buffer_read_ack;
811 udi_gfx_buffer_write_req_op_t *gfx_buffer_write_ack;
812 } udi_gfx_provider_ops_t;
814 /* Structure: udi_gfx_client_ops_t
816 * The graphics metalanguage entry points (client side)
818 typedef const struct {
819 udi_channel_event_ind_op_t *channel_event_ind_op;
820 udi_gfx_bind_ack_op_t *udi_gfx_bind_ack;
821 udi_gfx_unbind_ack_op_t *udi_gfx_unbind_ack;
822 udi_gfx_set_connector_ack_op_t *udi_gfx_set_connector_ack;
823 udi_gfx_set_engine_ack_op_t *udi_gfx_set_engine_ack;
824 udi_gfx_set_connector_nak_op_t *udi_gfx_set_connector_nak;
825 udi_gfx_set_engine_nak_op_t *udi_gfx_set_engine_nak;
826 udi_gfx_get_connector_ack_op_t *udi_gfx_get_connector_ack;
827 udi_gfx_get_engine_ack_op_t *udi_gfx_get_engine_ack;
828 udi_gfx_range_connector_ack_op_t *udi_gfx_range_connector_ack;
829 udi_gfx_range_engine_ack_op_t *udi_gfx_range_engine_ack;
830 udi_gfx_get_engine_operator_req_op_t*udi_gfx_get_engine_operator_ack;
831 udi_gfx_connector_command_ack_op_t *udi_gfx_connector_command_ack;
832 udi_gfx_engine_command_ack_op_t *udi_gfx_engine_command_ack;
833 udi_gfx_buffer_info_ack_op_t *gfx_buffer_info_ack;
834 udi_gfx_buffer_read_ack_op_t *gfx_buffer_read_ack;
835 udi_gfx_buffer_write_ack_op_t *gfx_buffer_write_ack;
836 udi_gfx_buffer_read_nak_op_t *gfx_buffer_read_nak;
837 udi_gfx_buffer_write_nak_op_t *gfx_buffer_write_nak;
838 } udi_gfx_client_ops_t;
843 void EngineReturnSimpleRange (int source, int index, int prop, int first, int last, int modulus);
844 void ConnectorReturnSimpleRange (int source, int index, int prop, int first, int last, int modulus);
845 void EngineReturnConstantRange (int source, int index, int prop, int value);
846 void ConnectorReturnConstantRange (int source, int index, int prop, int value);
847 void EngineReturnBooleanRange (int source, int index, int prop, int value1, int value2);
848 void ConnectorReturnBooleanRange (int source, int index, int prop, int value1, int value2);