drivers/mxc/gpu-viv/arch/GC350/hal/kernel/gc_hal_kernel_hardware_command_vg.h

   1 /****************************************************************************
   2 *
   3 *    Copyright (C) 2005 - 2011 by Vivante Corp.
   4 *
   5 *    This program is free software; you can redistribute it and/or modify
   6 *    it under the terms of the GNU General Public License as published by
   7 *    the Free Software Foundation; either version 2 of the license, or
   8 *    (at your option) any later version.
   9 *
  10 *    This program is distributed in the hope that it will be useful,
  11 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 *    GNU General Public License for more details.
  14 *
  15 *    You should have received a copy of the GNU General Public License
  16 *    along with this program; if not write to the Free Software
  17 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 *
  19 *****************************************************************************/
  20
  21
  22
  23
  24
  25
  26 #ifndef __gc_hal_kernel_hardware_command_vg_h_
  27 #define __gc_hal_kernel_hardware_command_vg_h_
  28
  29 /******************************************************************************\
  30 ******************* Task and Interrupt Management Structures. ******************
  31 \******************************************************************************/
  32
  33 /* Task storage header. */
  34 typedef struct _gcsTASK_STORAGE * gcsTASK_STORAGE_PTR;
  35 typedef struct _gcsTASK_STORAGE
  36 {
  37     /* Next allocated storage buffer. */
  38     gcsTASK_STORAGE_PTR         next;
  39 }
  40 gcsTASK_STORAGE;
  41
  42 /* Task container header. */
  43 typedef struct _gcsTASK_CONTAINER * gcsTASK_CONTAINER_PTR;
  44 typedef struct _gcsTASK_CONTAINER
  45 {
  46     /* The number of tasks left to be processed in the container. */
  47     gctINT                      referenceCount;
  48
  49     /* Size of the buffer. */
  50     gctUINT                     size;
  51
  52     /* Link to the previous and the next allocated containers. */
  53     gcsTASK_CONTAINER_PTR       allocPrev;
  54     gcsTASK_CONTAINER_PTR       allocNext;
  55
  56     /* Link to the previous and the next containers in the free list. */
  57     gcsTASK_CONTAINER_PTR       freePrev;
  58     gcsTASK_CONTAINER_PTR       freeNext;
  59 }
  60 gcsTASK_CONTAINER;
  61
  62 /* Kernel space task master table entry. */
  63 typedef struct _gcsBLOCK_TASK_ENTRY * gcsBLOCK_TASK_ENTRY_PTR;
  64 typedef struct _gcsBLOCK_TASK_ENTRY
  65 {
  66     /* Pointer to the current task container for the block. */
  67     gcsTASK_CONTAINER_PTR       container;
  68
  69     /* Pointer to the current task data within the container. */
  70     gcsTASK_HEADER_PTR          task;
  71
  72     /* Pointer to the last link task within the container. */
  73     gcsTASK_LINK_PTR            link;
  74
  75     /* Number of interrupts allocated for this block. */
  76     gctUINT                     interruptCount;
  77
  78     /* The index of the current interrupt. */
  79     gctUINT                     interruptIndex;
  80
  81     /* Interrupt semaphore. */
  82     gctSEMAPHORE                interruptSemaphore;
  83
  84     /* Interrupt value array. */
  85     gctINT32                    interruptArray[32];
  86 }
  87 gcsBLOCK_TASK_ENTRY;
  88
  89
  90 /******************************************************************************\
  91 ********************* Command Queue Management Structures. *********************
  92 \******************************************************************************/
  93
  94 /* Command queue kernel element pointer. */
  95 typedef struct _gcsKERNEL_CMDQUEUE * gcsKERNEL_CMDQUEUE_PTR;
  96
  97 /* Command queue object handler function type. */
  98 typedef gceSTATUS (* gctOBJECT_HANDLER) (
  99     gckVGKERNEL Kernel,
 100     gcsKERNEL_CMDQUEUE_PTR Entry
 101     );
 102
 103 /* Command queue kernel element. */
 104 typedef struct _gcsKERNEL_CMDQUEUE
 105 {
 106     /* The number of buffers in the queue. */
 107     gcsCMDBUFFER_PTR            commandBuffer;
 108
 109     /* Pointer to the object handler function. */
 110     gctOBJECT_HANDLER           handler;
 111 }
 112 gcsKERNEL_CMDQUEUE;
 113
 114 /* Command queue header. */
 115 typedef struct _gcsKERNEL_QUEUE_HEADER * gcsKERNEL_QUEUE_HEADER_PTR;
 116 typedef struct _gcsKERNEL_QUEUE_HEADER
 117 {
 118     /* The size of the buffer in bytes. */
 119     gctUINT                     size;
 120
 121     /* The number of pending entries to be processed. */
 122     volatile gctUINT            pending;
 123
 124     /* The current command queue entry. */
 125     gcsKERNEL_CMDQUEUE_PTR      currentEntry;
 126
 127     /* Next buffer. */
 128     gcsKERNEL_QUEUE_HEADER_PTR  next;
 129 }
 130 gcsKERNEL_QUEUE_HEADER;
 131
 132
 133 /******************************************************************************\
 134 ******************************* gckVGCOMMAND Object *******************************
 135 \******************************************************************************/
 136
 137 /* gckVGCOMMAND object. */
 138 struct _gckVGCOMMAND
 139 {
 140     /***************************************************************************
 141     ** Object data and pointers.
 142     */
 143
 144     gcsOBJECT                   object;
 145     gckVGKERNEL                 kernel;
 146     gckOS                       os;
 147     gckVGHARDWARE                   hardware;
 148
 149     /* Features. */
 150     gctBOOL                     fe20;
 151     gctBOOL                     vg20;
 152     gctBOOL                     vg21;
 153
 154
 155     /***************************************************************************
 156     ** Enable command queue dumping.
 157     */
 158
 159     gctBOOL                     enableDumping;
 160
 161
 162     /***************************************************************************
 163     ** Bus Error interrupt.
 164     */
 165
 166     gctINT32                    busErrorInt;
 167
 168
 169     /***************************************************************************
 170     ** Command buffer information.
 171     */
 172
 173     gcsCOMMAND_BUFFER_INFO      info;
 174
 175
 176     /***************************************************************************
 177     ** Synchronization objects.
 178     */
 179
 180     gctPOINTER                  queueMutex;
 181     gctPOINTER                  taskMutex;
 182     gctPOINTER                  commitMutex;
 183
 184
 185     /***************************************************************************
 186     ** Task management.
 187     */
 188
 189     /* The head of the storage buffer linked list. */
 190     gcsTASK_STORAGE_PTR         taskStorage;
 191
 192     /* Allocation size. */
 193     gctUINT                     taskStorageGranularity;
 194     gctUINT                     taskStorageUsable;
 195
 196     /* The free container list. */
 197     gcsTASK_CONTAINER_PTR       taskFreeHead;
 198     gcsTASK_CONTAINER_PTR       taskFreeTail;
 199
 200     /* Task table */
 201     gcsBLOCK_TASK_ENTRY         taskTable[gcvBLOCK_COUNT];
 202
 203
 204     /***************************************************************************
 205     ** Command queue.
 206     */
 207
 208     /* Pointer to the allocated queue memory. */
 209     gcsKERNEL_QUEUE_HEADER_PTR  queue;
 210
 211     /* Pointer to the current available queue from which new queue entries
 212        will be allocated. */
 213     gcsKERNEL_QUEUE_HEADER_PTR  queueHead;
 214
 215     /* If different from queueHead, points to the command queue which is
 216        currently being executed by the hardware. */
 217     gcsKERNEL_QUEUE_HEADER_PTR  queueTail;
 218
 219     /* Points to the queue to merge the tail with when the tail is processed. */
 220     gcsKERNEL_QUEUE_HEADER_PTR  mergeQueue;
 221
 222     /* Queue overflow counter. */
 223     gctUINT                     queueOverflow;
 224
 225
 226     /***************************************************************************
 227     ** Context.
 228     */
 229
 230     /* Context counter used for unique ID. */
 231     gctUINT64                   contextCounter;
 232
 233     /* Current context ID. */
 234     gctUINT64                   currentContext;
 235 };
 236
 237 /******************************************************************************\
 238 ************************ gckVGCOMMAND Object Internal API. ***********************
 239 \******************************************************************************/
 240
 241 /* Initialize architecture dependent command buffer information. */
 242 gceSTATUS
 243 gckVGCOMMAND_InitializeInfo(
 244     IN gckVGCOMMAND Command
 245     );
 246
 247 /* Form a STATE command at the specified location in the command buffer. */
 248 gceSTATUS
 249 gckVGCOMMAND_StateCommand(
 250     IN gckVGCOMMAND Command,
 251     IN gctUINT32 Pipe,
 252     IN gctPOINTER Logical,
 253     IN gctUINT32 Address,
 254     IN gctSIZE_T Count,
 255     IN OUT gctSIZE_T * Bytes
 256     );
 257
 258 /* Form a RESTART command at the specified location in the command buffer. */
 259 gceSTATUS
 260 gckVGCOMMAND_RestartCommand(
 261     IN gckVGCOMMAND Command,
 262     IN gctPOINTER Logical,
 263     IN gctUINT32 FetchAddress,
 264     IN gctUINT FetchCount,
 265     IN OUT gctSIZE_T * Bytes
 266     );
 267
 268 /* Form a FETCH command at the specified location in the command buffer. */
 269 gceSTATUS
 270 gckVGCOMMAND_FetchCommand(
 271     IN gckVGCOMMAND Command,
 272     IN gctPOINTER Logical,
 273     IN gctUINT32 FetchAddress,
 274     IN gctUINT FetchCount,
 275     IN OUT gctSIZE_T * Bytes
 276     );
 277
 278 /* Form a CALL command at the specified location in the command buffer. */
 279 gceSTATUS
 280 gckVGCOMMAND_CallCommand(
 281     IN gckVGCOMMAND Command,
 282     IN gctPOINTER Logical,
 283     IN gctUINT32 FetchAddress,
 284     IN gctUINT FetchCount,
 285     IN OUT gctSIZE_T * Bytes
 286     );
 287
 288 /* Form a RETURN command at the specified location in the command buffer. */
 289 gceSTATUS
 290 gckVGCOMMAND_ReturnCommand(
 291     IN gckVGCOMMAND Command,
 292     IN gctPOINTER Logical,
 293     IN OUT gctSIZE_T * Bytes
 294     );
 295
 296 /* Form an EVENT command at the specified location in the command buffer. */
 297 gceSTATUS
 298 gckVGCOMMAND_EventCommand(
 299     IN gckVGCOMMAND Command,
 300     IN gctPOINTER Logical,
 301     IN gceBLOCK Block,
 302     IN gctINT32 InterruptId,
 303     IN OUT gctSIZE_T * Bytes
 304     );
 305
 306 /* Form an END command at the specified location in the command buffer. */
 307 gceSTATUS
 308 gckVGCOMMAND_EndCommand(
 309     IN gckVGCOMMAND Command,
 310     IN gctPOINTER Logical,
 311     IN gctINT32 InterruptId,
 312     IN OUT gctSIZE_T * Bytes
 313     );
 314
 315 #endif  /* __gc_hal_kernel_hardware_command_h_ */
 316