1/* Copyright (c) 2013-2017 Jeffrey Pfau
  2 *
  3 * This Source Code Form is subject to the terms of the Mozilla Public
  4 * License, v. 2.0. If a copy of the MPL was not distributed with this
  5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  6#ifndef DS_GX_H
  7#define DS_GX_H
  8
  9#include <mgba-util/common.h>
 10
 11CXX_GUARD_START
 12
 13#include <mgba/core/interface.h>
 14#include <mgba/core/log.h>
 15#include <mgba/core/timing.h>
 16#include <mgba/internal/ds/matrix.h>
 17#include <mgba-util/circle-buffer.h>
 18
 19mLOG_DECLARE_CATEGORY(DS_GX);
 20
 21#define DS_GX_POLYGON_BUFFER_SIZE 2048
 22#define DS_GX_VERTEX_BUFFER_SIZE 6144
 23
 24DECL_BITFIELD(DSRegGXSTAT, uint32_t);
 25DECL_BIT(DSRegGXSTAT, TestBusy, 0);
 26DECL_BIT(DSRegGXSTAT, BoxTestResult, 1);
 27DECL_BITS(DSRegGXSTAT, PVMatrixStackLevel, 8, 5);
 28DECL_BIT(DSRegGXSTAT, ProjMatrixStackLevel, 13);
 29DECL_BIT(DSRegGXSTAT, MatrixStackBusy, 14);
 30DECL_BIT(DSRegGXSTAT, MatrixStackError, 15);
 31DECL_BITS(DSRegGXSTAT, FIFOEntries, 16, 9);
 32DECL_BIT(DSRegGXSTAT, FIFOFull, 24);
 33DECL_BIT(DSRegGXSTAT, FIFOLtHalf, 25);
 34DECL_BIT(DSRegGXSTAT, FIFOEmpty, 26);
 35DECL_BIT(DSRegGXSTAT, Busy, 27);
 36DECL_BITS(DSRegGXSTAT, DoIRQ, 30, 2);
 37
 38DECL_BITFIELD(DSGXTexParams, uint32_t);
 39DECL_BITS(DSGXTexParams, VRAMBase, 0, 16);
 40DECL_BIT(DSGXTexParams, SRepeat, 16);
 41DECL_BIT(DSGXTexParams, TRepeat, 17);
 42DECL_BIT(DSGXTexParams, SMirror, 18);
 43DECL_BIT(DSGXTexParams, TMirror, 19);
 44DECL_BITS(DSGXTexParams, SSize, 20, 3);
 45DECL_BITS(DSGXTexParams, TSize, 23, 3);
 46DECL_BITS(DSGXTexParams, Format, 26, 3);
 47DECL_BIT(DSGXTexParams, 0Transparent, 29);
 48DECL_BITS(DSGXTexParams, CoordTfMode, 30, 2);
 49
 50DECL_BITFIELD(DSGXPolygonAttrs, uint32_t);
 51DECL_BITS(DSGXPolygonAttrs, Lights, 0, 4);
 52DECL_BITS(DSGXPolygonAttrs, Mode, 4, 2);
 53DECL_BIT(DSGXPolygonAttrs, FrontFace, 6);
 54DECL_BIT(DSGXPolygonAttrs, BackFace, 7);
 55DECL_BIT(DSGXPolygonAttrs, UpdateDepth, 11);
 56// TODO
 57DECL_BITS(DSGXPolygonAttrs, Alpha, 16, 5);
 58
 59enum DSGXCommand {
 60	DS_GX_CMD_NOP = 0,
 61	DS_GX_CMD_MTX_MODE = 0x10,
 62	DS_GX_CMD_MTX_PUSH = 0x11,
 63	DS_GX_CMD_MTX_POP = 0x12,
 64	DS_GX_CMD_MTX_STORE = 0x13,
 65	DS_GX_CMD_MTX_RESTORE = 0x14,
 66	DS_GX_CMD_MTX_IDENTITY = 0x15,
 67	DS_GX_CMD_MTX_LOAD_4x4 = 0x16,
 68	DS_GX_CMD_MTX_LOAD_4x3 = 0x17,
 69	DS_GX_CMD_MTX_MULT_4x4 = 0x18,
 70	DS_GX_CMD_MTX_MULT_4x3 = 0x19,
 71	DS_GX_CMD_MTX_MULT_3x3 = 0x1A,
 72	DS_GX_CMD_MTX_SCALE = 0x1B,
 73	DS_GX_CMD_MTX_TRANS = 0x1C,
 74	DS_GX_CMD_COLOR = 0x20,
 75	DS_GX_CMD_NORMAL = 0x21,
 76	DS_GX_CMD_TEXCOORD = 0x22,
 77	DS_GX_CMD_VTX_16 = 0x23,
 78	DS_GX_CMD_VTX_10 = 0x24,
 79	DS_GX_CMD_VTX_XY = 0x25,
 80	DS_GX_CMD_VTX_XZ = 0x26,
 81	DS_GX_CMD_VTX_YZ = 0x27,
 82	DS_GX_CMD_VTX_DIFF = 0x28,
 83	DS_GX_CMD_POLYGON_ATTR = 0x29,
 84	DS_GX_CMD_TEXIMAGE_PARAM = 0x2A,
 85	DS_GX_CMD_PLTT_BASE = 0x2B,
 86	DS_GX_CMD_DIF_AMB = 0x30,
 87	DS_GX_CMD_SPE_EMI = 0x31,
 88	DS_GX_CMD_LIGHT_VECTOR = 0x32,
 89	DS_GX_CMD_LIGHT_COLOR = 0x33,
 90	DS_GX_CMD_SHININESS = 0x34,
 91	DS_GX_CMD_BEGIN_VTXS = 0x40,
 92	DS_GX_CMD_END_VTXS = 0x41,
 93	DS_GX_CMD_SWAP_BUFFERS = 0x50,
 94	DS_GX_CMD_VIEWPORT = 0x60,
 95	DS_GX_CMD_BOX_TEST = 0x70,
 96	DS_GX_CMD_POS_TEST = 0x71,
 97	DS_GX_CMD_VEC_TEST = 0x72,
 98
 99	DS_GX_CMD_MAX
100};
101
102#pragma pack(push, 1)
103struct DSGXEntry {
104	uint8_t command;
105	uint8_t params[4];
106};
107#pragma pack(pop)
108
109struct DSGXVertex {
110	// World coords
111	int16_t x; // 4.12
112	int16_t y; // 4.12
113	int16_t z; // 4.12
114
115	// Color/Texcoords
116	uint16_t color; // 5.5.5
117	int16_t s; // 12.4
118	int16_t t; // 12.4
119
120	// Viewport coords
121	int32_t vx;
122	int32_t vy;
123	int32_t vz;
124	int32_t vw;
125	int16_t vs; // 12.4
126	int16_t vt; // 12.4
127};
128
129struct DSGXPolygon {
130	uint32_t polyParams;
131	DSGXTexParams texParams;
132	uint32_t palBase;
133	int verts;
134	unsigned vertIds[10];
135};
136
137struct DSGXRenderer {
138	void (*init)(struct DSGXRenderer* renderer);
139	void (*reset)(struct DSGXRenderer* renderer);
140	void (*deinit)(struct DSGXRenderer* renderer);
141
142	void (*invalidateTex)(struct DSGXRenderer* renderer, int slot);
143	void (*setRAM)(struct DSGXRenderer* renderer, struct DSGXVertex* verts, struct DSGXPolygon* polys, unsigned polyCount, bool wSort);
144	void (*drawScanline)(struct DSGXRenderer* renderer, int y);
145	void (*getScanline)(struct DSGXRenderer* renderer, int y, const color_t** output);
146
147	uint16_t* tex[4];
148	uint16_t* texPal[6];
149
150	int viewportX;
151	int viewportY;
152	int viewportWidth;
153	int viewportHeight;
154};
155
156struct DSGXLight {
157	int16_t color;
158	int16_t x;
159	int16_t y;
160	int16_t z;
161};
162
163struct DS;
164struct DSGX {
165	struct DS* p;
166	struct DSGXRenderer* renderer;
167	struct CircleBuffer fifo;
168	struct CircleBuffer pipe;
169
170	struct mTimingEvent fifoEvent;
171	int dmaSource;
172
173	int outstandingParams[4];
174	uint8_t outstandingCommand[4];
175	struct DSGXEntry outstandingEntry;
176
177	int activeParams;
178	struct DSGXEntry activeEntries[32];
179
180	bool swapBuffers;
181	bool wSort;
182	int bufferIndex;
183	int vertexIndex;
184	int pendingVertexIndex;
185	int polygonIndex;
186	struct DSGXVertex* vertexBuffer[2];
187	struct DSGXPolygon* polygonBuffer[2];
188	struct DSGXVertex pendingVertices[8];
189	int pendingVertexIds[8];
190	bool reverseWinding;
191
192	uint16_t* tex[4];
193	uint16_t* texPal[6];
194
195	int mtxMode;
196	int pvMatrixPointer;
197	struct DSGXMatrix projMatrixStack;
198	struct DSGXMatrix texMatrixStack;
199	struct DSGXMatrix posMatrixStack[32];
200	struct DSGXMatrix vecMatrixStack[32];
201
202	struct DSGXMatrix projMatrix;
203	struct DSGXMatrix texMatrix;
204	struct DSGXMatrix posMatrix;
205	struct DSGXMatrix vecMatrix;
206
207	struct DSGXMatrix clipMatrix;
208
209	struct DSGXLight lights[4];
210	int16_t diffuse;
211	int16_t ambient;
212	int16_t specular;
213	int16_t emit;
214
215	int viewportX1;
216	int viewportY1;
217	int viewportX2;
218	int viewportY2;
219	int viewportWidth;
220	int viewportHeight;
221
222	int vertexMode;
223	struct DSGXVertex currentVertex;
224	struct DSGXPolygon nextPoly;
225	struct DSGXPolygon currentPoly;
226};
227
228void DSGXInit(struct DSGX*);
229void DSGXDeinit(struct DSGX*);
230void DSGXReset(struct DSGX*);
231void DSGXAssociateRenderer(struct DSGX* video, struct DSGXRenderer* renderer);
232
233uint16_t DSGXWriteRegister(struct DSGX*, uint32_t address, uint16_t value);
234uint32_t DSGXWriteRegister32(struct DSGX*, uint32_t address, uint32_t value);
235
236void DSGXFlush(struct DSGX*);
237void DSGXUpdateGXSTAT(struct DSGX*);
238
239struct GBADMA;
240struct DSCommon;
241void DSGXScheduleDMA(struct DSCommon* dscore, int number, struct GBADMA* info);
242
243CXX_GUARD_END
244
245#endif