1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
2 
3 /*
4  * Copyright (C) 2014 Rob Clark <robclark@freedesktop.org>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the next
14  * paragraph) shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  * Authors:
26  *    Rob Clark <robclark@freedesktop.org>
27  */
28 
29 #ifndef SCRIPT_H_
30 #define SCRIPT_H_
31 
32 #include <stdint.h>
33 
34 
35 // XXX make script support optional
36 #define ENABLE_SCRIPTING 1
37 
38 #ifdef ENABLE_SCRIPTING
39 
40 /* called at start to load the script: */
41 int script_load(const char *file);
42 
43 /* called at start of each cmdstream file: */
44 void script_start_cmdstream(const char *name);
45 
46 /* called at each DRAW_INDX, calls script drawidx fxn to process
47  * the current state
48  */
49 __attribute__((weak))
50 void script_draw(const char *primtype, uint32_t nindx);
51 
52 struct rnn;
53 struct rnndomain;
54 __attribute__((weak))
55 void script_packet(uint32_t *dwords, uint32_t sizedwords,
56 		struct rnn *rnn, struct rnndomain *dom);
57 
58 /* maybe at some point it is interesting to add additional script
59  * hooks for CP_EVENT_WRITE, etc?
60  */
61 
62 /* called at end of each cmdstream file: */
63 void script_end_cmdstream(void);
64 
65 void script_start_submit(void);
66 void script_end_submit(void);
67 
68 /* called after last cmdstream file: */
69 void script_finish(void);
70 
71 #else
72 // TODO no-op stubs..
73 #endif
74 
75 
76 #endif /* SCRIPT_H_ */
77