summaryrefslogtreecommitdiffstats
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* README: Begin documenting development style rulesAndrew Jeffery2018-03-191-1/+49
| | | | | | | | The first rule enforces the use of stdout/stderr for logging. Rationale is provided in the README. Change-Id: Ibb5b62ea1341aa951fd42b15e9cd14a836842032 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* docs: Create Documentation folder and add mboxd and mboxctl documentationSuraj Jitindar Singh2017-04-111-637/+9
| | | | | | | | | | | | | | | Create a separate folder for documentation called Documentation. Move the protocol definition into a file in this folder called mbox_protocol.md and update the README.md to explain the files in the docs folder. Also add two other files to the folder called mboxd.md and mboxctl.md which document the operation of the reference implementations of the mailbox daemon and the mailbox control program respectively. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: I9f818700ad1e36a396a828f0f085b42cc106b550
* README: Change open window commands to return actual flash offsetSuraj Jitindar Singh2017-04-111-2/+12
| | | | | | | | | | | | | | The open window commands now return in part of the response the acutal flash offset which the window maps. That is the actual flash offset returned is the flash offset of the data which will be presented at the lpc bus address returned. Additionally deprecate the window size fields in get_mbox_info as the window size is no longer fixed or required to be consistent between windows. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: Ib170d96e66a5f6eb8bc070e56dfe78f1a6b26e57
* README: Update README to describe version 2 of the mbox protocolSuraj Jitindar Singh2017-04-051-178/+497
| | | | | | | | | | | | | | | | | | | | | | | | A second version (V2) of the mbox protocol has been designed to allow more flexibility of the BMC implementation while allowing the host to provide some directives as to what it may access in the future to allow the BMC to prefetch data. The main changes to the protocol in V2 are: - All sizes specified in block size - When opening a window the host provides a size directive and the response contains the actual size of the window. - Add an erase command to make it easier to erase large areas - Add more response codes - Add more BMC->Host event codes Additionally further description of the protocol flow and the commands was added for clarity. These changes are now documented in the README document which describes the mbox protocol. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: I0d7a683e0d48810f5f404a0edd58804cbf9ecb35
* README: Add general overview informationAndrew Jeffery2017-02-271-10/+96
| | | | | | | | | | | This was extracted from email chains doing the rounds. It's more useful to have it available out in the open, so lets put it in the README. Full credit for the text goes to Mikey Neuling. Change-Id: Ic5fb8b53c2ca5538737ad6ce532d0c5b79f3413b Scribed-by: Michael Neuling <mikey@neuling.org> Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* README: Move autotools comment away from introductionAndrew Jeffery2017-02-271-2/+4
| | | | | | | | | The comment is more about how to build the software, not so much about what the purpose of the software is. As such I don't think it's worthy of being part of the introduction. Change-Id: Iacabd12f89fe569ea11af9d1d66ab1d6f0c7beef Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* README: Update protocol notesCyril Bur2017-02-061-65/+153
| | | | | Change-Id: I1ee76bd4fd0b23c2a8eb150fbe8e0b9c3086c074 Signed-off-by: Cyril Bur <cyril.bur@au1.ibm.com>
* README.mdCyril Bur2017-01-171-0/+148
OpenPOWER on IntegriCloud