Changeset 3184 in vbox for trunk/include/VBox
- Timestamp:
- Jun 20, 2007 1:40:16 PM (18 years ago)
- File:
-
- 1 edited
-
trunk/include/VBox/iom.h (modified) (14 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/VBox/iom.h
r3145 r3184 43 43 /** 44 44 * Macro for checking if an I/O or MMIO emulation call succeeded. 45 * 46 * This macro shall only be used with the IOM APIs where it's mentioned 45 * 46 * This macro shall only be used with the IOM APIs where it's mentioned 47 47 * in the return value description. And there is must be used to correctly 48 48 * determin if the call succeeded and things like the EIP needs updating. 49 * 50 * 49 * 50 * 51 51 * @returns Success indicator (true/false). 52 * 52 * 53 53 * @param rc The status code. This may be evaluated 54 54 * more than once! 55 * 55 * 56 56 * @remark To avoid making assumptions about the layout of the 57 57 * VINF_EM_FIRST...VINF_EM_LAST range we're checking … … 62 62 * VINF_EM_RESCHEDULE_REM status code is the most 63 63 * frequent status code we'll enounter in this range. 64 * 64 * 65 65 * @todo Will have to add VINF_EM_DBG_HYPER_BREAKPOINT if the 66 66 * I/O port and MMIO breakpoints should trigger before … … 298 298 * Reads an I/O port register. 299 299 * 300 * @returns Strict VBox status code. Informational status codes other than the one documented 301 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 302 * @retval VINF_SUCCESS Success. 303 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 300 * @returns Strict VBox status code. Informational status codes other than the one documented 301 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 302 * @retval VINF_SUCCESS Success. 303 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 304 304 * status code must be passed on to EM. 305 305 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only) … … 315 315 * Writes to an I/O port register. 316 316 * 317 * @returns Strict VBox status code. Informational status codes other than the one documented 318 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 319 * @retval VINF_SUCCESS Success. 320 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 317 * @returns Strict VBox status code. Informational status codes other than the one documented 318 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 319 * @retval VINF_SUCCESS Success. 320 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 321 321 * status code must be passed on to EM. 322 322 * @retval VINF_IOM_HC_IOPORT_WRITE Defer the write to ring-3. (R0/GC only) … … 332 332 * OUT <DX|imm16>, <AL|AX|EAX> 333 333 * 334 * @returns Strict VBox status code. Informational status codes other than the one documented 335 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 336 * @retval VINF_SUCCESS Success. 337 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 334 * @returns Strict VBox status code. Informational status codes other than the one documented 335 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 336 * @retval VINF_SUCCESS Success. 337 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 338 338 * status code must be passed on to EM. 339 339 * @retval VINF_IOM_HC_IOPORT_WRITE Defer the write to ring-3. (R0/GC only) … … 351 351 * IN <AL|AX|EAX>, <DX|imm16> 352 352 * 353 * @returns Strict VBox status code. Informational status codes other than the one documented 354 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 355 * @retval VINF_SUCCESS Success. 356 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 353 * @returns Strict VBox status code. Informational status codes other than the one documented 354 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 355 * @retval VINF_SUCCESS Success. 356 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 357 357 * status code must be passed on to EM. 358 358 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only) … … 371 371 * Reads the string buffer of an I/O port register. 372 372 * 373 * @returns Strict VBox status code. Informational status codes other than the one documented 374 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 375 * @retval VINF_SUCCESS Success. 376 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 373 * @returns Strict VBox status code. Informational status codes other than the one documented 374 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 375 * @retval VINF_SUCCESS Success. 376 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 377 377 * status code must be passed on to EM. 378 378 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only) … … 389 389 * Writes the string buffer of an I/O port register. 390 390 * 391 * @returns Strict VBox status code. Informational status codes other than the one documented 391 * @returns Strict VBox status code. Informational status codes other than the one documented 392 392 * here are to be treated as internal failure. 393 393 * @retval VINF_SUCCESS Success. 394 394 * @retval VINF_EM_FIRST-VINF_EM_LAST Success but schedulinging information needs to be passed onto EM. 395 395 * @retval VINF_IOM_HC_IOPORT_WRITE Defer the write to ring-3. (R0/GC only) 396 * 396 * 397 397 * @param pVM VM handle. 398 398 * @param Port The port to write. … … 407 407 * ES:EDI,DX[,ECX] 408 408 * 409 * @returns Strict VBox status code. Informational status codes other than the one documented 410 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 411 * @retval VINF_SUCCESS Success. 412 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 409 * @returns Strict VBox status code. Informational status codes other than the one documented 410 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 411 * @retval VINF_SUCCESS Success. 412 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 413 413 * status code must be passed on to EM. 414 414 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only) 415 * @retval VINF_EM_RAW_EMULATE_INSTR Defer the read to the REM. 415 416 * @retval VINF_EM_RAW_GUEST_TRAP The exception was left pending. (TRPMRaiseXcptErr) 416 417 * @retval VINF_TRPM_XCPT_DISPATCHED The exception was raised and dispatched for raw-mode execution. (TRPMRaiseXcptErr) … … 429 430 * @remark Assumes caller checked the access privileges (IOMInterpretCheckPortIOAccess) 430 431 * 431 * @returns Strict VBox status code. Informational status codes other than the one documented 432 * here are to be treated as internal failure. 433 * @retval VINF_SUCCESS Success. 434 * @retval VINF_EM_FIRST-VINF_EM_LAST Success but schedulinging information needs to be passed onto EM. 432 * @returns Strict VBox status code. Informational status codes other than the one documented 433 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 434 * @retval VINF_SUCCESS Success. 435 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 436 * status code must be passed on to EM. 435 437 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only) 438 * @retval VINF_EM_RAW_EMULATE_INSTR Defer the read to the REM. 436 439 * @retval VINF_EM_RAW_GUEST_TRAP The exception was left pending. (TRPMRaiseXcptErr) 437 440 * @retval VINF_TRPM_XCPT_DISPATCHED The exception was raised and dispatched for raw-mode execution. (TRPMRaiseXcptErr) … … 450 453 * DS:ESI,DX[,ECX] 451 454 * 452 * @returns Strict VBox status code. Informational status codes other than the one documented 453 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 454 * @retval VINF_SUCCESS Success. 455 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 455 * @returns Strict VBox status code. Informational status codes other than the one documented 456 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 457 * @retval VINF_SUCCESS Success. 458 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 456 459 * status code must be passed on to EM. 457 460 * @retval VINF_IOM_HC_IOPORT_WRITE Defer the write to ring-3. (R0/GC only) 461 * @retval VINF_EM_RAW_EMULATE_INSTR Defer the write to the REM. 458 462 * @retval VINF_EM_RAW_GUEST_TRAP The exception was left pending. (TRPMRaiseXcptErr) 459 463 * @retval VINF_TRPM_XCPT_DISPATCHED The exception was raised and dispatched for raw-mode execution. (TRPMRaiseXcptErr) … … 472 476 * @remark Assumes caller checked the access privileges (IOMInterpretCheckPortIOAccess) 473 477 * 474 * @returns Strict VBox status code. Informational status codes other than the one documented 475 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 476 * @retval VINF_SUCCESS Success. 477 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 478 * @returns Strict VBox status code. Informational status codes other than the one documented 479 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 480 * @retval VINF_SUCCESS Success. 481 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 478 482 * status code must be passed on to EM. 479 483 * @retval VINF_IOM_HC_IOPORT_WRITE Defer the write to ring-3. (R0/GC only) 484 * @retval VINF_EM_RAW_EMULATE_INSTR Defer the write to the REM. 480 485 * @retval VINF_EM_RAW_GUEST_TRAP The exception was left pending. (TRPMRaiseXcptErr) 481 486 * @retval VINF_TRPM_XCPT_DISPATCHED The exception was raised and dispatched for raw-mode execution. (TRPMRaiseXcptErr) … … 526 531 * level and I/O bitmap. 527 532 * 528 * @returns Strict VBox status code. Informational status codes other than the one documented 533 * @returns Strict VBox status code. Informational status codes other than the one documented 529 534 * here are to be treated as internal failure. 530 535 * @retval VINF_SUCCESS Success. … … 553 558 * trap is a in or out type instruction. (Call it indirectly via EM that is.) 554 559 * 555 * @returns Strict VBox status code. Informational status codes other than the one documented 556 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 557 * @retval VINF_SUCCESS Success. 558 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 560 * @returns Strict VBox status code. Informational status codes other than the one documented 561 * here are to be treated as internal failure. Use IOM_SUCCESS() to check for success. 562 * @retval VINF_SUCCESS Success. 563 * @retval VINF_EM_FIRST-VINF_EM_LAST Success with some exceptions (see IOM_SUCCESS()), the 559 564 * status code must be passed on to EM. 560 565 * @retval VINF_IOM_HC_IOPORT_READ Defer the read to ring-3. (R0/GC only)
Note:
See TracChangeset
for help on using the changeset viewer.
