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_BIT(DSGXPolygonAttrs, Light0, 0);
 52DECL_BIT(DSGXPolygonAttrs, Light1, 1);
 53DECL_BIT(DSGXPolygonAttrs, Light2, 2);
 54DECL_BIT(DSGXPolygonAttrs, Light3, 3);
 55DECL_BITS(DSGXPolygonAttrs, Mode, 4, 2);
 56DECL_BIT(DSGXPolygonAttrs, FrontFace, 6);
 57DECL_BIT(DSGXPolygonAttrs, BackFace, 7);
 58// TODO
 59DECL_BITS(DSGXPolygonAttrs, Alpha, 16, 5);
 60
 61enum DSGXCommand {
 62	DS_GX_CMD_NOP = 0,
 63	DS_GX_CMD_MTX_MODE = 0x10,
 64	DS_GX_CMD_MTX_PUSH = 0x11,
 65	DS_GX_CMD_MTX_POP = 0x12,
 66	DS_GX_CMD_MTX_STORE = 0x13,
 67	DS_GX_CMD_MTX_RESTORE = 0x14,
 68	DS_GX_CMD_MTX_IDENTITY = 0x15,
 69	DS_GX_CMD_MTX_LOAD_4x4 = 0x16,
 70	DS_GX_CMD_MTX_LOAD_4x3 = 0x17,
 71	DS_GX_CMD_MTX_MULT_4x4 = 0x18,
 72	DS_GX_CMD_MTX_MULT_4x3 = 0x19,
 73	DS_GX_CMD_MTX_MULT_3x3 = 0x1A,
 74	DS_GX_CMD_MTX_SCALE = 0x1B,
 75	DS_GX_CMD_MTX_TRANS = 0x1C,
 76	DS_GX_CMD_COLOR = 0x20,
 77	DS_GX_CMD_NORMAL = 0x21,
 78	DS_GX_CMD_TEXCOORD = 0x22,
 79	DS_GX_CMD_VTX_16 = 0x23,
 80	DS_GX_CMD_VTX_10 = 0x24,
 81	DS_GX_CMD_VTX_XY = 0x25,
 82	DS_GX_CMD_VTX_XZ = 0x26,
 83	DS_GX_CMD_VTX_YZ = 0x27,
 84	DS_GX_CMD_VTX_DIFF = 0x28,
 85	DS_GX_CMD_POLYGON_ATTR = 0x29,
 86	DS_GX_CMD_TEXIMAGE_PARAM = 0x2A,
 87	DS_GX_CMD_PLTT_BASE = 0x2B,
 88	DS_GX_CMD_DIF_AMB = 0x30,
 89	DS_GX_CMD_SPE_EMI = 0x31,
 90	DS_GX_CMD_LIGHT_VECTOR = 0x32,
 91	DS_GX_CMD_LIGHT_COLOR = 0x33,
 92	DS_GX_CMD_SHININESS = 0x34,
 93	DS_GX_CMD_BEGIN_VTXS = 0x40,
 94	DS_GX_CMD_END_VTXS = 0x41,
 95	DS_GX_CMD_SWAP_BUFFERS = 0x50,
 96	DS_GX_CMD_VIEWPORT = 0x60,
 97	DS_GX_CMD_BOX_TEST = 0x70,
 98	DS_GX_CMD_POS_TEST = 0x71,
 99	DS_GX_CMD_VEC_TEST = 0x72,
100
101	DS_GX_CMD_MAX
102};
103
104#pragma pack(push, 1)
105struct DSGXEntry {
106	uint8_t command;
107	uint8_t params[4];
108};
109#pragma pack(pop)
110
111struct DSGXVertex {
112	// World coords
113	int16_t x; // 4.12
114	int16_t y; // 4.12
115	int16_t z; // 4.12
116
117	// Color/Texcoords
118	uint16_t color; // 5.5.5
119	int16_t s; // 12.4
120	int16_t t; // 12.4
121
122	// Viewport coords
123	int32_t vx;
124	int32_t vy;
125	int32_t vz;
126	int32_t vw;
127	int16_t vs; // 12.4
128	int16_t vt; // 12.4
129};
130
131struct DSGXPolygon {
132	uint32_t polyParams;
133	DSGXTexParams texParams;
134	uint32_t palBase;
135	int verts;
136	unsigned vertIds[4];
137};
138
139struct DSGXRenderer {
140	void (*init)(struct DSGXRenderer* renderer);
141	void (*reset)(struct DSGXRenderer* renderer);
142	void (*deinit)(struct DSGXRenderer* renderer);
143
144	void (*invalidateTex)(struct DSGXRenderer* renderer, int slot);
145	void (*setRAM)(struct DSGXRenderer* renderer, struct DSGXVertex* verts, struct DSGXPolygon* polys, unsigned polyCount, bool wSort);
146	void (*drawScanline)(struct DSGXRenderer* renderer, int y);
147	void (*getScanline)(struct DSGXRenderer* renderer, int y, const color_t** output);
148
149	uint16_t* tex[4];
150	uint16_t* texPal[6];
151};
152
153struct DS;
154struct DSGX {
155	struct DS* p;
156	struct DSGXRenderer* renderer;
157	struct CircleBuffer fifo;
158	struct CircleBuffer pipe;
159
160	struct mTimingEvent fifoEvent;
161	int dmaSource;
162
163	int outstandingParams[4];
164	uint8_t outstandingCommand[4];
165	struct DSGXEntry outstandingEntry;
166
167	int activeParams;
168	struct DSGXEntry activeEntries[32];
169
170	bool swapBuffers;
171	bool wSort;
172	int bufferIndex;
173	int vertexIndex;
174	int polygonIndex;
175	struct DSGXVertex* vertexBuffer[2];
176	struct DSGXPolygon* polygonBuffer[2];
177
178	uint16_t* tex[4];
179	uint16_t* texPal[6];
180
181	int mtxMode;
182	int pvMatrixPointer;
183	struct DSGXMatrix projMatrixStack;
184	struct DSGXMatrix texMatrixStack;
185	struct DSGXMatrix posMatrixStack[32];
186	struct DSGXMatrix vecMatrixStack[32];
187
188	struct DSGXMatrix projMatrix;
189	struct DSGXMatrix texMatrix;
190	struct DSGXMatrix posMatrix;
191	struct DSGXMatrix vecMatrix;
192
193	struct DSGXMatrix clipMatrix;
194
195	int viewportX1;
196	int viewportY1;
197	int viewportX2;
198	int viewportY2;
199	int viewportWidth;
200	int viewportHeight;
201
202	int vertexMode;
203	struct DSGXVertex currentVertex;
204	struct DSGXPolygon nextPoly;
205	struct DSGXPolygon currentPoly;
206};
207
208void DSGXInit(struct DSGX*);
209void DSGXDeinit(struct DSGX*);
210void DSGXReset(struct DSGX*);
211void DSGXAssociateRenderer(struct DSGX* video, struct DSGXRenderer* renderer);
212
213uint16_t DSGXWriteRegister(struct DSGX*, uint32_t address, uint16_t value);
214uint32_t DSGXWriteRegister32(struct DSGX*, uint32_t address, uint32_t value);
215
216void DSGXFlush(struct DSGX*);
217void DSGXUpdateGXSTAT(struct DSGX*);
218
219struct GBADMA;
220struct DSCommon;
221void DSGXScheduleDMA(struct DSCommon* dscore, int number, struct GBADMA* info);
222
223CXX_GUARD_END
224
225#endif