summaryrefslogtreecommitdiffstats
path: root/src/doc
Commit message (Collapse)AuthorAgeFilesLines
* [pxe] Introduce PXE exit hook for NBP chainingShao Miller2010-01-241-0/+33
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It might be the case that we wish to chain to an NBP without being "in the way". We now implement a hook in our exit path for gPXE *.*pxe build targets. The hook is a pointer to a SEG16:OFF16 which we try to jump to during exit. By default, this pointer results in the usual exit path. We also implement the "pxenv_file_exit_hook" PXE API routine to allow the user to specify an alternate SEG16:OFF16 to jump to during exit. Unfortunately, this additional PXE extension has a cost in code size. Fortunately, a look at the size difference for a gPXE .rom build target shows zero size difference after compression. The routine is documented in doc/pxe_extensions as follows: FILE EXIT HOOK Op-Code: PXENV_FILE_EXIT_HOOK (00e7h) Input: Far pointer to a t_PXENV_FILE_EXIT_HOOK parameter structure that has been initialized by the caller. Output: PXENV_EXIT_SUCCESS or PXENV_EXIT_FAILURE must be returned in AX. The Status field in the parameter structure must be set to one of the values represented by the PXENV_STATUS_xxx constants. Description:Modify the exit path to jump to the specified code. Only valid for pxeprefix-based builds. typedef struct s_PXENV_FILE_EXIT_HOOK { PXENV_STATUS_t Status; SEGOFF16_t Hook; } t_PXENV_FILE_EXIT_HOOK; Set before calling API service: Hook: The SEG16:OFF16 of the code to jump to. Returned from API service: Status: See PXENV_STATUS_xxx constants. Requested-by: H. Peter Anvin <hpa@zytor.com> Signed-off-by: Shao Miller <shao.miller@yrdsb.edu.on.ca> Signed-off-by: Marty Connor <mdc@etherboot.org>
* [PXEXT] Update documentationH. Peter Anvin2008-03-261-2/+88
| | | | | Add documentation for the FILE_EXEC and FILE_CHECK_API extension calls, and update the documentation for the FILE_READ call.
* Added PXENV_GET_FILE_SIZE.Michael Brown2007-07-061-1/+43
| | | | | | | Documented non-blocking nature of PXENV_FILE_READ. Changed FileName field in PXENV_FILE_OPEN to be a SEGOFF16, to avoid a fixed 256-byte length limit on URLs.
* First draft of PXE extensions API.Michael Brown2007-07-051-0/+151
|
* Documented the link stagesMichael Brown2005-05-201-7/+226
|
* Documented the compilation stagesMichael Brown2005-05-201-0/+200
|
* doxygen docs go in bin/docMichael Brown2005-05-181-1/+0Star
|
* All files in here are auto-generatedMichael Brown2005-05-181-0/+1