Cleanup GPFIFO comments and make Run() private

This commit is contained in:
Billy Laws 2021-10-30 18:55:06 +01:00 committed by PixelyIon
parent 2577658fc7
commit 2494cafee8

View File

@ -82,8 +82,8 @@ namespace skyline::soc::gm20b {
/** /**
* @brief The ChannelGpfifo class handles creating pushbuffers from GP entries and then processing them for a single channel * @brief The ChannelGpfifo class handles creating pushbuffers from GP entries and then processing them for a single channel
* @note A single ChannelGpfifo thread exists per channel with a single shared mutex in `GPFIFO` to enforce that only one channel can run at a time * @note A single ChannelGpfifo thread exists per channel, allowing them to run asynchronously
* @note This class doesn't perfectly map to any particular hardware component on the X1, it does a mix of the GPU Host PBDMA (With and handling the GPFIFO entries * @note This class doesn't perfectly map to any particular hardware component on the X1, it does a mix of the GPU Host PBDMA and handling the GPFIFO entries
* @url https://github.com/NVIDIA/open-gpu-doc/blob/ab27fc22db5de0d02a4cabe08e555663b62db4d4/manuals/volta/gv100/dev_pbdma.ref.txt#L62 * @url https://github.com/NVIDIA/open-gpu-doc/blob/ab27fc22db5de0d02a4cabe08e555663b62db4d4/manuals/volta/gv100/dev_pbdma.ref.txt#L62
*/ */
class ChannelGpfifo { class ChannelGpfifo {
@ -126,6 +126,11 @@ namespace skyline::soc::gm20b {
*/ */
void Process(GpEntry gpEntry); void Process(GpEntry gpEntry);
/**
* @brief Executes all pending entries in the FIFO and polls for more
*/
void Run();
public: public:
/** /**
* @param numEntries The number of gpEntries to allocate space for in the FIFO * @param numEntries The number of gpEntries to allocate space for in the FIFO
@ -134,11 +139,6 @@ namespace skyline::soc::gm20b {
~ChannelGpfifo(); ~ChannelGpfifo();
/**
* @brief Executes all pending entries in the FIFO
*/
void Run();
/** /**
* @brief Pushes a list of entries to the FIFO, these commands will be executed on calls to 'Process' * @brief Pushes a list of entries to the FIFO, these commands will be executed on calls to 'Process'
*/ */