phosphor-mboxd/Documentation/mboxd.md

7   http://www.apache.org/licenses/LICENSE-2.0
26 mboxd_dbus.c -    Contains the handlers for the D-Bus commands which the daemon can
28 mboxd_flash.c -   Contains the functions for performing flash access including
30 mboxd_lpc.c -     Contains the functions for controlling the LPC bus mapping
31                   including pointing the bus so it maps flash and memory.
32 mboxd_msg.c -     Contains the handlers for the mbox commands which the daemon
34 mboxd_windows.c - Contains the functions for managing the window cache.
42 UNINITIALISED -         The daemon is still in the initialisation phase and
44 ACTIVE_MAPS_FLASH -     The daemon is polling for incoming commands, is not
45                         currently suspended and the LPC bus maps the flash
47 SUSPEND_MAPS_FLASH -    The daemon is polling for incoming commands, is
48                         currently suspended and the LPC bus maps the flash
50 ACTIVE_MAPS_MEM -       The daemon is polling for incoming commands, is not
51                         currently suspended and the LPC bus maps the reserved
53 SUSPEND_MAPS_MEM -      The daemon is polling for incoming commands, is
54                         currently suspended and the LPC bus maps the reserved
66 UNINITIALISED -> ACTIVE_MAPS_FLASH -      Uninitiated: Occurs when the daemon is
68 ACTIVE_MAPS_FLASH -> SUSPEND_MAPS_FLASH - Suspend command received over
69                                           D-Bus
70 SUSPEND_MAPS_FLASH -> ACTIVE_MAPS_FLASH - Resume command received over
71                                           D-Bus
72 ACTIVE_MAPS_MEM -> SUSPEND_MAPS_MEM -     Suspend command received over D-Bus
73 SUSPEND_MAPS_MEM -> ACTIVE_MAPS_MEM -     Resume command received over D-Bus
74 ACTIVE_MAPS_FLASH -> ACTIVE_MAPS_MEM -    GET_MBOX_INFO command received
75 SUSPEND_MAPS_FLASH -> SUSPEND_MAPS_MEM -  GET_MBOX_INFO command received
76 ACTIVE_MAPS_MEM -> ACTIVE_MAPS_FLASH -    Reset D-Bus or mbox command received
77 SUSPEND_MAPS_MEM -> SUSPEND_MAPS_FLASH -  Transition not allowed, we
98 this window and the host pointed at its location on the LPC bus.
110 (*) - required
111 (#) - optional but recommended
112 (~) - optional
114 --flash *       - The size of the PNOR image on the flash device
115 --window-size # - The size to make each window in the cache
116 --window-num #  - The number of windows to have in the cache
117 --verbose ~     - Increase the verbosity with which the daemon runs
118 --sys-log ~     - Use the system log rather than outputting to the console
123 If window-size and window-num aren't specified then the default is to have a
138 the mbox, D-Bus or signal file descriptors.
149 #### Handling D-Bus Commands
151 When an event occurs on the D-Bus file descriptor the D-Bus request is read from
152 the D-Bus interface and processed.
155 is then written back to the D-Bus interface to indicate the outcome of the
167 SIGINT -  Terminate the daemon
168 SIGTERM - Terminate the daemon
169 SIGHUP -  Clear the window cache and point the LPC bus mapping back to
176 to initialise, received SIGINT or SIGTERM, or because it received the kill D-Bus
180 active window has been closed, points the LPC bus mapping back to flash, clears