bios-bmc-smm-error-logger/include/buffer.hpp

51         return std::tie(this->bmcInterfaceVersion, this->biosInterfaceVersion,  in operator ==()
52                         this->magicNumber, this->queueSize, this->ueRegionSize,  in operator ==()
53                         this->bmcFlags, this->bmcReadPtr, this->biosFlags,  in operator ==()
54                         this->biosWritePtr) ==  in operator ==()
73         return std::tie(this->sequenceId, this->entrySize, this->checksum,  in operator ==()
74                         this->rdeCommandType) ==  in operator ==()
88     virtual ~BufferInterface() = default;
93      * @param[in] bmcInterfaceVersion - Used to initialize the header
94      * @param[in] queueSize - Used to initialize the header
95      * @param[in] ueRegionSize - Used to initialize the header
96      * @param[in] magicNumber - Used to initialize the header
99     virtual void initialize(uint32_t bmcInterfaceVersion, uint16_t queueSize,
106     virtual void readBufferHeader() = 0;
112     virtual struct CircularBufferHeader getCachedBufferHeader() const = 0;
116      * @param[in] newReadPtr - read pointer to update to
118     virtual void updateReadPtr(const uint32_t newReadPtr) = 0;
122      * @param[in] newBmcFlags - new flag to update to
124     virtual void updateBmcFlags(const uint32_t newBmcFlags) = 0;
127      * Wrapper for the dataInterface->read, performs wraparound read
129      * @param[in] relativeOffset - offset relative the "Error Log
131      * @param[in] length - bytes to read
134     virtual std::vector<uint8_t> wraparoundRead(const uint32_t relativeOffset,
141     virtual struct QueueEntryHeader readEntryHeader() = 0;
148     virtual EntryPair readEntry() = 0;
151      * Read the buffer - this API should be used instead of individual functions
156     virtual std::vector<EntryPair> readErrorLogs() = 0;
159      * Get max offset for the queue
161      * * @return Queue size - UE region size - Queue header size
163     virtual size_t getMaxOffset() = 0;
169     virtual size_t getQueueOffset() = 0;
179      *  @param[in] dataInterface     - DataInterface for this object
199      *  @param[in] entry     - Span to calculate the checksum on