diff options
author | Gunnar Mills <gmills@us.ibm.com> | 2017-08-17 13:16:18 -0500 |
---|---|---|
committer | Gunnar Mills <gmills@us.ibm.com> | 2017-08-22 08:45:13 -0500 |
commit | 97578a6b567c262c327ea44711c5030c8e00ff9d (patch) | |
tree | 9779f700530640dee53a288ab17bd6eccd7512cd | |
parent | 4bcf02bf961f2ca94674c6196e7466c4f5dcb4e1 (diff) | |
download | phosphor-mboxbridge-97578a6b567c262c327ea44711c5030c8e00ff9d.tar.gz phosphor-mboxbridge-97578a6b567c262c327ea44711c5030c8e00ff9d.zip |
Spelling and grammar fixes for mboxd.md
Change-Id: Ie653e70d709d5d616666bbc072042589d16a802f
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
-rw-r--r-- | Documentation/mboxd.md | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/Documentation/mboxd.md b/Documentation/mboxd.md index d60925d..a1f4227 100644 --- a/Documentation/mboxd.md +++ b/Documentation/mboxd.md @@ -23,11 +23,11 @@ The main mailbox daemon is implemented in mboxd.c. This file uses helper functions from the various mboxd_*.c files. ``` -mboxd_dbus.c - Contains the handlers for the dbus commands which the daemon can +mboxd_dbus.c - Contains the handlers for the D-Bus commands which the daemon can receive. mboxd_flash.c - Contains the functions for performing flash access including read, write and erase. -mboxd_lpc.c - Contains the functions for controlling the lpc bus mapping +mboxd_lpc.c - Contains the functions for controlling the LPC bus mapping including pointing the bus so it maps flash and memory. mboxd_msg.c - Contains the handlers for the mbox commands which the daemon can receive. @@ -42,16 +42,16 @@ The daemon is a state machine with 5 valid states: UNINITIALISED - The daemon is still in the initialisation phase and will not respond ACTIVE_MAPS_FLASH - The daemon is polling for incoming commands, is not - currently suspended and the lpc bus maps the flash + currently suspended and the LPC bus maps the flash device. SUSPEND_MAPS_FLASH - The daemon is polling for incoming commands, is - currently suspended and the lpc bus maps the flash + currently suspended and the LPC bus maps the flash device. ACTIVE_MAPS_MEM - The daemon is polling for incoming commands, is not - currently suspended and the lpc bus maps the reserved + currently suspended and the LPC bus maps the reserved memory region. SUSPEND_MAPS_MEM - The daemon is polling for incoming commands, is - currently suspended and the lpc bus maps the reserved + currently suspended and the LPC bus maps the reserved memory region. ``` @@ -66,14 +66,14 @@ flash. UNINITIALISED -> ACTIVE_MAPS_FLASH - Uninitiated: Occurs when the daemon is finished initialising. ACTIVE_MAPS_FLASH -> SUSPEND_MAPS_FLASH - Suspend command received over - dbus + D-Bus SUSPEND_MAPS_FLASH -> ACTIVE_MAPS_FLASH - Resume command received over - dbus -ACTIVE_MAPS_MEM -> SUSPEND_MAPS_MEM - Suspend command received over dbus -SUSPEND_MAPS_MEM -> ACTIVE_MAPS_MEM - Resume command received over dbus + D-Bus +ACTIVE_MAPS_MEM -> SUSPEND_MAPS_MEM - Suspend command received over D-Bus +SUSPEND_MAPS_MEM -> ACTIVE_MAPS_MEM - Resume command received over D-Bus ACTIVE_MAPS_FLASH -> ACTIVE_MAPS_MEM - GET_MBOX_INFO command received SUSPEND_MAPS_FLASH -> SUSPEND_MAPS_MEM - GET_MBOX_INFO command received -ACTIVE_MAPS_MEM -> ACTIVE_MAPS_FLASH - Reset dbus or mbox command received +ACTIVE_MAPS_MEM -> ACTIVE_MAPS_FLASH - Reset D-Bus or mbox command received SUSPEND_MAPS_MEM -> SUSPEND_MAPS_FLASH - Transition not allowed, we don't let the host modify flash while the daemon is suspended. @@ -88,14 +88,14 @@ reload them from flash should the host access them again in the future. The reserved memory region is divided among a number of windows which make up the window cache. When the host requests a flash offset the cache is searched for one which contains that offset. If one is found we simply point the host to -it at the correct lpc offset for that windows location and the requested flash +it at the correct LPC offset for that windows location and the requested flash offset. If there is no window in the cache which contains the requested flash offset then we have to find one to load with the requested flash contents. If there -are any windows which are empty then we choose those, otherwise we choose one to +are any windows which are empty then we choose those, otherwise, we choose one to evict using a least recently used (LRU) scheme. The flash is then copied into -this window and the host pointed at its location on the lpc bus. +this window and the host pointed at its location on the LPC bus. When ever the flash is changed we have to invalidate all windows in the window cache as their contents may no longer accurately reflect those of the flash. @@ -115,7 +115,7 @@ The daemon is invoked on the command line with a few parameters: --window-size # - The size to make each window in the cache --window-num # - The number of windows to have in the cache --verbose ~ - Increase the verbosity with which the daemon runs ---sys-log ~ - Use the system log rather than outputing to the console +--sys-log ~ - Use the system log rather than outputting to the console ``` If any of the required parameters are missing or invalid an error will be @@ -129,13 +129,13 @@ After the command line has been parsed the daemon will initalise its various interfaces. If any of these initialisations fail it will print an error and the daemon will terminate. -After initilisation the daemon points the lpc mapping to the actual flash +After initilisation, the daemon points the LPC mapping to the actual flash device, sets the BMC_READY BMC event and starts polling. ### Polling The daemon sits in a poll loop waiting for an event to happen on one or more of -the mbox, dbus or signal file descriptors. +the mbox, D-Bus or signal file descriptors. #### Handling MBOX Commands @@ -144,15 +144,15 @@ the mbox registers and processed. The command is validated and then the appropriate handler called. The response is then written back to the mbox registers to indicate the outcome of the -command and an interrupt generated to the host. +command and an interrupt is sent to the host. -#### Handling DBUS Commands +#### Handling D-Bus Commands -When an event occurs on the dbus file descriptor the dbus request is read from -the dbus interface and processed. +When an event occurs on the D-Bus file descriptor the D-Bus request is read from +the D-Bus interface and processed. The command is validated and then the appropriate handler called. The response -is then written back to the dbus interface to indicate the outcome of the +is then written back to the D-Bus interface to indicate the outcome of the command. #### Handling Signals @@ -166,16 +166,16 @@ and processed as follows: ``` SIGINT - Terminate the daemon SIGTERM - Terminate the daemon -SIGHUP - Clear the window cache and point the lpc bus mapping back to +SIGHUP - Clear the window cache and point the LPC bus mapping back to flash ``` ### Termination The daemon can be terminated for multiple reasons; invalid command line, unable -to initialise, received SIGINT or SIGTERM, or because it received the kill dbus +to initialise, received SIGINT or SIGTERM, or because it received the kill D-Bus command. -On termination the daemon clears the window cache and notifys the host that the -active window has been closed, points the lpc bus mapping back to flash, clears +On termination, the daemon clears the window cache and notifies the host that the +active window has been closed, points the LPC bus mapping back to flash, clears the BMC_READY BMC event bit and frees all of its allocated resources. |