1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/*
Vita Development Suite Libraries
*/
#ifndef _VDSUITE_USER_GXM_MEMORY_H
#define _VDSUITE_USER_GXM_MEMORY_H
/** @file
Memory mapping API for the GPU.
*/
#include_next <gxm/memory.h>
#ifdef __cplusplus
extern "C" {
#endif // def __cplusplus
/** The device heap ID when allocating memory using #sceGxmAllocDeviceMemLinux().
@ingroup render
*/
typedef enum SceGxmDeviceHeapId {
SCE_GXM_DEVICE_HEAP_ID_USER_NC,
SCE_GXM_DEVICE_HEAP_ID_CDRAM,
SCE_GXM_DEVICE_HEAP_ID_VERTEX_USSE,
SCE_GXM_DEVICE_HEAP_ID_FRAGMENT_USSE
} SceGxmDeviceHeapId;
/** Memory info for memory allocated and mapped using #sceGxmAllocDeviceMemLinux().
@ingroup render
*/
typedef struct SceGxmDeviceMemInfo {
SceUID memBlockId; ///< The UID of the allocated memory block.
void *mappedBase; ///< Base address of the allocated memory block.
uint32_t offset; ///< USSE offset for vertex and fragment USSE memory.
uint32_t size; ///< The size passed to #sceGxmAllocDeviceMemLinux().
uint32_t heapId; ///< The device heap ID from #SceGxmDeviceHeapId.
} SceGxmDeviceMemInfo;
/** Checks if memory is mapped for GPU usage. If mapped, pointers within the region of
memory described by <c><i>base</i></c> and <c><i>size</i></c> may be used with libgxm
functions directly.
@param[in] base The base address of the region to check.
@param[in] size The size in bytes of the region to check.
@param[in] attribs Bitwise combined attributes from #SceGxmMemoryAttribFlags.
@retval
SCE_OK The memory region is mapped with <c><i>attribs</i></c>.
@retval
SCE_GXM_ERROR_UNINITIALIZED The operation failed because the library was not initialized.
@retval
SCE_GXM_ERROR_DRIVER The operation failed due to a driver error.
@retval
SCE_GXM_ERROR_INVALID_MAPPING The memory region is not mapped with <c><i>attribs</i></c>.
@ingroup render
*/
SceGxmErrorCode sceGxmCheckMappedMemory(void *base, uint32_t size, uint32_t attribs);
/** Maps memory for vertex USSE code usage. If successful, this mapping
operation returns a USSE offset to address the memory as vertex USSE code.
@param[in] base A 4K-aligned base address of the region to map.
@param[in] size A 4K-aligned size in bytes of the region to map. This
cannot be greater than 8MB.
@param[in] offset A pointer to a 32-bit value to hold the USSE offset.
@retval
SCE_OK The operation was completed successfully.
@retval
SCE_GXM_ERROR_UNINITIALIZED The operation failed because the library was not initialized.
@retval
SCE_GXM_ERROR_INVALID_POINTER The operation failed because a pointer was invalid.
@retval
SCE_GXM_ERROR_INVALID_VALUE The operation failed because a parameter was invalid.
@retval
SCE_GXM_ERROR_DRIVER The operation failed due to a driver error.
@ingroup render
*/
SceGxmErrorCode sceGxmMapVertexUsseMemoryInternal(void *base, uint32_t size, uint32_t *offset);
/** Unmaps memory that was previously mapped as vertex USSE code. It is the
responsibility of the caller to ensure that the GPU no longer needs this
memory for rendering. This could be accomplished by calling #sceGxmFinish()
before unmapping.
@param[in] base The base address of the region to unmap. This must match
the base address that was used when mapping the memory
using #sceGxmMapVertexUsseMemory().
@retval
SCE_OK The operation was completed successfully.
@retval
SCE_GXM_ERROR_UNINITIALIZED The operation failed because the library was not initialized.
@retval
SCE_GXM_ERROR_INVALID_POINTER The operation failed because a pointer was invalid.
@retval
SCE_GXM_ERROR_DRIVER The operation failed due to a driver error.
@ingroup render
*/
SceGxmErrorCode sceGxmUnmapVertexUsseMemoryInternal(void *base);
/** Maps memory for fragment USSE code usage. If successful, this mapping
operation returns a USSE offset to address the memory as fragment USSE code.
@param[in] base A 4K-aligned base address of the region to map.
@param[in] size A 4K-aligned size in bytes of the region to map. This
cannot be greater than 8MB.
@param[in] offset A pointer to a 32-bit value to hold the USSE offset.
@retval
SCE_OK The operation was completed successfully.
@retval
SCE_GXM_ERROR_UNINITIALIZED The operation failed because the library was not initialized.
@retval
SCE_GXM_ERROR_INVALID_POINTER The operation failed because a pointer was invalid.
@retval
SCE_GXM_ERROR_INVALID_VALUE The operation failed because a parameter was invalid.
@retval
SCE_GXM_ERROR_DRIVER The operation failed due to a driver error.
@ingroup render
*/
SceGxmErrorCode sceGxmMapFragmentUsseMemoryInternal(void *base, uint32_t size, uint32_t *offset);
/** Unmaps memory that was previously mapped as fragment USSE code. It is the
responsibility of the caller to ensure that the GPU no longer needs this
memory for rendering. This could be accomplished by calling #sceGxmFinish()
before unmapping.
@param[in] base The base address of the region to unmap. This must match
the base address that was used when mapping the memory
using #sceGxmMapFragmentUsseMemory().
@retval
SCE_OK The operation was completed successfully.
@retval
SCE_GXM_ERROR_UNINITIALIZED The operation failed because the library was not initialized.
@retval
SCE_GXM_ERROR_INVALID_POINTER The operation failed because a pointer was invalid.
@retval
SCE_GXM_ERROR_DRIVER The operation failed due to a driver error.
@ingroup render
*/
SceGxmErrorCode sceGxmUnmapFragmentUsseMemoryInternal(void *base);
/** Allocates and maps memory for GPU usage. The storage for the memory info is
allocated by libgxm.
@param[in] heapId Device memory heap ID from #SceGxmDeviceHeapId.
@param[in] flags Bitwise combined attributes from #SceGxmMemoryAttribFlags.
@param[in] size Size in bytes of the memory to allocate.
@param[in] alignment This parameter is unused. Specify 0 or a power of 2.
@param[out] memInfo Memory info of the allocated memory.
@retval
SCE_OK The operation was completed successfully.
@retval
SCE_GXM_ERROR_OUT_OF_MEMORY There was no memory to perform the operation.
@retval
SCE_GXM_ERROR_INVALID_VALUE The operation failed because a parameter was invalid.
@retval
SCE_GXM_ERROR_INVALID_POINTER The operation failed because a pointer was invalid.
@retval
SCE_GXM_ERROR_INVALID_ALIGNMENT The operation failed due to invalid alignment.
@ingroup render
*/
SceGxmErrorCode sceGxmAllocDeviceMemLinux(uint32_t heapId, uint32_t flags, uint32_t size, uint32_t alignment, SceGxmDeviceMemInfo **memInfo);
/** Unmaps and frees memory allocated with #sceGxmAllocDeviceMemLinux(). The
storage for the memory info is freed by libgxm.
@param[in] memInfo Memory info of the allocated memory.
@retval
SCE_OK The operation was completed successfully.
@ingroup render
*/
SceGxmErrorCode sceGxmFreeDeviceMemLinux(SceGxmDeviceMemInfo* memInfo);
#ifdef __cplusplus
}
#endif // def __cplusplus
#endif /* _VDSUITE_USER_GXM_MEMORY_H */
|
