phosphor-mboxd/Documentation/mbox_protocol.md

78 The idea is to have the LPC FW space be routed to an active "window".  That
206 referred to as the active window.
208 When the active window is a write window the host can perform MARK_WRITE_DIRTY,
243 past the end of the active window. On returning success to either of the create
247 There is only ever one active window which is the window created by the most
249 though there are two types of windows there can still only be one active window
254 A window can be closed by calling CLOSE_WINDOW in which case there is no active
256 If the host closes an active write window then the BMC must perform an
257 implicit flush. If the host tries to open a new window with an already active
258 window then the active window is closed (and implicitly flushed if it was a
260 active window, if the command fails then there is no active window and the
261 previously active window must no longer be accessed.
264 the active window. The host must not use write management functions (see below)
265 if the active window is a read window or if there is no active window.
273 MARK_WRITE_ERASED command to erase large parts of the active window without the
276 active window marked dirty/erased is only marked for the lifetime of the current
277 active write window and does not persist if the active window is closed either
281 for the active window. The host must not assume that any changes have been
283 active write window was successful or a create window command with an active
314 assume that there is no longer an active window - that is if there was an
315 active window it has been closed by the BMC and if it was a write window
322 contents of the active window could be inconsistent with the contents of flash.
391 WINDOW_ERROR	- Command not valid for active window or no active window
545 		active window.
559 		is the active window. If it fails then there is no active
574 		Closes the active window. Any further access to the LPC bus
575 		address specified to address the previously active window will
576 		have undefined effects. If the active window is a
612 		active window (V2)) and a zero offset refers to the first
613 		block. If the offset + number exceeds the size of the active
637 		Flushes any dirty/erased blocks in the active window to
644 		exceeds the size of the active window then the command must not
674 		Offset is the offset within the active window to start erasing
675 		from (zero refers to the first block of the active window) and
676 		number is the number of blocks of the active window to erase
678 		the active window then the command must not succeed.
743 	must assume it has no active window. The host must not assume
746 	The host must assume that its active window has been closed and
747 	that it no longer has an active window. The host is not
767 	The host must not assume that the contents of the active window