Преглед на файлове

[PXEXT] Update documentation

Add documentation for the FILE_EXEC and FILE_CHECK_API extension
calls, and update the documentation for the FILE_READ call.
tags/v0.9.4
H. Peter Anvin преди 16 години
родител
ревизия
d810dc5be2
променени са 1 файла, в които са добавени 88 реда и са изтрити 2 реда
  1. 88
    2
      src/doc/pxe_extensions

+ 88
- 2
src/doc/pxe_extensions Целия файл

@@ -125,8 +125,9 @@ Output:		PXENV_EXIT_SUCCESS or PXENV_EXIT_FAILURE must be
125 125
 		This API function is non-blocking.  PXENV_EXIT_SUCCESS
126 126
 		and PXENV_STATUS_SUCCESS is returned if a data block
127 127
 		has been transferred into the caller's buffer.
128
-		PXENV_EXIT_FAILURE and PXENV_STATUS_FAILURE is
129
-		returned if no data is available to transfer.
128
+		PXENV_EXIT_FAILURE and PXENV_STATUS_TFTP_OPEN is
129
+		returned if no data is available to transfer; any
130
+		other status code reflects an error.
130 131
 
131 132
 Description:	Read from a previously opened file.
132 133
 
@@ -191,3 +192,88 @@ Returned from API service:
191 192
 FileSize:	Size of the file in bytes.
192 193
 
193 194
 Status:		See PXENV_STATUS_xxx constants.
195
+
196
+
197
+
198
+
199
+FILE EXEC
200
+
201
+Op-Code:	PXENV_FILE_EXEC (00e5h)
202
+
203
+Input:		Far pointer to a t_PXENV_FILE_EXEC parameter
204
+		structure that has been initialized by the caller.
205
+
206
+Output:		PXENV_EXIT_SUCCESS or PXENV_EXIT_FAILURE must be
207
+		returned in AX.  The Status field in the parameter
208
+		structure must be set to one of the values represented
209
+		by the PXENV_STATUS_xxx constants.
210
+
211
+Description:	Execute a gPXE command.
212
+
213
+typedef struct s_PXENV_FILE_EXEC {
214
+        PXENV_STATUS_t Status;
215
+        SEGOFF16_t Command;
216
+} t_PXENV_FILE_EXEC;
217
+
218
+
219
+Set before calling API service:
220
+
221
+Command:	Command to execute.  Null terminated.
222
+
223
+
224
+Returned from API service:
225
+
226
+Status:		See PXENV_STATUS_xxx constants.
227
+
228
+
229
+
230
+
231
+FILE API CHECK
232
+
233
+Op-Code:	PXENV_FILE_API_CHECK (00e6h)
234
+
235
+Input:		Far pointer to a t_PXENV_FILE_CHECK_API parameter
236
+		structure that has been initialized by the caller.
237
+
238
+		On entry, the Magic field should contain the number
239
+		0x91d447b2 or the call will fail.
240
+
241
+Output:		PXENV_EXIT_SUCCESS or PXENV_EXIT_FAILURE must be
242
+		returned in AX.  The Status field in the parameter
243
+		structure must be set to one of the values represented
244
+		by the PXENV_STATUS_xxx constants.
245
+
246
+		If this API is present and the Magic field contains the
247
+		proper value on entry, AX will contain PXENV_EXIT_SUCCESS,
248
+		the Status field PXENV_STATUS_SUCCESS, and the Magic field
249
+		the number 0xe9c17b20.  Any other combination should be
250
+		considered a failure.
251
+
252
+Description:	Detect presence of this API.
253
+
254
+
255
+typedef struct s_PXENV_FILE_CHECK_API {
256
+	PXENV_STATUS Status;
257
+	UINT16 Size;
258
+	UINT32 Magic;
259
+	UINT32 Provider;
260
+	UINT32 APIMask;
261
+	UINT32 Flags;
262
+} t_PXENV_FILE_CHECK_API;
263
+
264
+Set before calling API service:
265
+
266
+Size:		Set to sizeof(t_PXENV_FILE_CHECK_API) (20).
267
+Magic:		Set to 0x91d447b2.
268
+
269
+
270
+Returned from API service:
271
+
272
+Size:		Set to the number of bytes filled in (20).
273
+Magic:		Set to 0xe9c17b20.
274
+Provider:	Set to 0x45585067 ("gPXE").  Another implementation of this
275
+		API can use another value, e.g. to indicate a different
276
+		command set supported by FILE EXEC.
277
+APIMask:	Bitmask of supported API functions (one bit for each function
278
+		in the range 00e0h to 00ffh).
279
+Flags:		Set to zero, reserved for future use.

Loading…
Отказ
Запис