Skip to content

Commit

Permalink
xboxkrnl: Add documentation for *_PORT_BUFFER_* methods
Browse files Browse the repository at this point in the history
  • Loading branch information
abaire authored and thrimbor committed Feb 5, 2022
1 parent f413a85 commit c081dd5
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions lib/xboxkrnl/xboxkrnl.h
Original file line number Diff line number Diff line change
Expand Up @@ -1729,20 +1729,38 @@ XBAPI XBOX_KEY_DATA XboxEEPROMKey;

XBAPI XBOX_KEY_DATA XboxAlternateSignatureKeys[];

/**
* Writes a number of USHORT values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PUSHORT)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer containing the values to be written.
* @param Count Specifies the number of values to be written to the port.
*/
XBAPI VOID NTAPI WRITE_PORT_BUFFER_USHORT
(
IN PUSHORT Port,
IN PUSHORT Buffer,
IN ULONG Count
);

/**
* Writes a number of ULONG values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PULONG)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer containing the values to be written.
* @param Count Specifies the number of values to be written to the port.
*/
XBAPI VOID NTAPI WRITE_PORT_BUFFER_ULONG
(
IN PULONG Port,
IN PULONG Buffer,
IN ULONG Count
);

/**
* Writes a number of UCHAR values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PUCHAR)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer containing the values to be written.
* @param Count Specifies the number of values to be written to the port.
*/
XBAPI VOID NTAPI WRITE_PORT_BUFFER_UCHAR
(
IN PUCHAR Port,
Expand Down Expand Up @@ -2302,20 +2320,38 @@ XBAPI NTSTATUS NTAPI RtlAnsiStringToUnicodeString
BOOLEAN AllocateDestinationString
);

/**
* Reads a number of USHORT values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PUSHORT)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer into which the array of values will be written.
* @param Count Specifies the number of values to be read from the port and written into the buffer.
*/
XBAPI VOID NTAPI READ_PORT_BUFFER_USHORT
(
IN PUSHORT Port,
OUT PUSHORT Buffer,
IN ULONG Count
);

/**
* Reads a number of ULONG values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PULONG)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer into which the array of values will be written.
* @param Count Specifies the number of values to be read from the port and written into the buffer.
*/
XBAPI VOID NTAPI READ_PORT_BUFFER_ULONG
(
IN PULONG Port,
OUT PULONG Buffer,
IN ULONG Count
);

/**
* Reads a number of UCHAR values from the specified port address into a buffer.
* @param Port The memory mapped I/O address of the port. E.g., `(PUCHAR)0x0cf8` for port 0x0CF8.
* @param Buffer Pointer to a buffer into which the array of values will be written.
* @param Count Specifies the number of values to be read from the port and written into the buffer.
*/
XBAPI VOID NTAPI READ_PORT_BUFFER_UCHAR
(
IN PUCHAR Port,
Expand Down

0 comments on commit c081dd5

Please sign in to comment.