phosphor-mboxbridge/Documentation, branch master

Documentation: Remove mboxctl.md

2019-03-20T04:36:16+00:00

The merge of phosphor-mboxd and mboxbridge blew away the content. No-one has complained, so remove the broken file. Change-Id: Ic52bb4c3946b03485197efce1f6c6ff7ef714c1c Signed-off-by: Andrew Jeffery

protocol: Rework publication of events over DBus transport

2018-11-26T04:54:32+00:00

A set of races was discovered around the propagation of HIOMAP protocol BMC status events during BMC shutdown. In particular the change impacts the design of the DBus transport defined in the protocol specification, as signalling of both acknowledgeable and non-acknowledgeable events could not be made atomic. A particular case where this matters is when the daemon is terminated, at which point it should simultaneously clear BMC_EVENT_DAEMON_READY and set BMC_EVENT_PROTOCOL_RESET. The DBus interface as designed required this be done as two separate messages, which lead to races propagating the complete state update to the host during shutdown of ipmid. Change-Id: Iaf38f77c28b8e4e4dd092b0de97dc7e777bfac65 Signed-off-by: Andrew Jeffery

Documentation: Rewrite protocol specification

2018-09-14T07:22:34+00:00

The rewrite addresses two main issues in the original documentation: 1. The conflation of the protocol specification with the mailbox transport 2. Formatting and discoverability of command and event definitions Additionally, the rewrite documents two new transports - IPMI and DBus. It's noted that DBus is intended as a transport internal to the BMC, while the IPMI transport is the new transport exposed to the host. Finally, some commands and events have been renamed, however this has no impact on the behaviour of the protocol. Change-Id: Icc78141f4ead4395e8a348b80443cadd2300a751 Signed-off-by: Andrew Jeffery

mboxd: Rename mboxd_msg to transport_mbox

2018-09-12T05:32:10+00:00

Change-Id: I0f4e206648c02a98fa938a7e582470c8d90904f1 Signed-off-by: Andrew Jeffery

mboxd: Rename windows files

2018-09-05T08:14:24+00:00

Change-Id: I44e110906fd0f751f8f34b175f971e65896a7301 Signed-off-by: Andrew Jeffery

mboxd: Rename lpc source files

2018-09-05T08:14:24+00:00

Change-Id: I289618c90b2df8911e362397b7eab99403c86c05 Signed-off-by: Andrew Jeffery

mboxd: Rename flash files

2018-09-05T08:14:24+00:00

Change-Id: Icfe9d61775a198c5a0f8227bf5d6c4b7f11aeec3 Signed-off-by: Andrew Jeffery

dbus: Use new bus name, object and interface

2018-09-05T08:14:24+00:00

The new interface is a more typical use of DBus, exposing multiple methods for the functions that are available on the object. The legacy interface by comparison exposed only one method whose arguments selected sub-commands to be executed. The legacy approach is not terribly discoverable and leads to a lack of clarity in the client code. The legacy approach also obscured the implementation with its use of `struct mbox_dbus_msg`. The new interface wraps around the existing helpers and so also deals with `struct mbox_dbus_msg`, but this can at least be removed in the future. Change-Id: I7113ed8fd2324bf3fb049d8d20acb3fd7fba6de3 Signed-off-by: Andrew Jeffery

Unfork phosphor-mboxd from mboxbridge

2018-08-03T02:44:12+00:00

Change-Id: I1b3b9d7fd47719594c1de027389959a5a9a3ea7a Signed-off-by: Andrew Jeffery

Point mailbox daemon documentation to mboxbridge

2017-11-17T12:42:41+00:00

Simlar to the update to mbox_protocol.md, those looking for the documentation on the mailbox daemon should refer to the more up-to-date version in the openbmc/mboxbridge repository. Change-Id: Iedea144ee70c9c4059f08ccb131ddc4ecec7ad36 Signed-off-by: Brandon Wyman