summaryrefslogtreecommitdiffstats
path: root/Documentation
Commit message (Collapse)AuthorAgeFilesLines
* Point mailbox daemon documentation to mboxbridgeBrandon Wyman2017-11-171-180/+2
| | | | | | | | | 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 <bjwyman@gmail.com>
* Point mailbox control protocol to mboxbridgeBrandon Wyman2017-11-171-109/+2
| | | | | | | | | Similar to the update to mbox_protocol.md, those looking for this documentation should refer to the more up-to-date version in the openbmc/mboxbridge repository. Change-Id: I659f9a26822b81e99261c855f3ee61392bc9d6d5 Signed-off-by: Brandon Wyman <bjwyman@gmail.com>
* Documentation: Point to canonical protocol documentationAndrew Jeffery2017-05-251-688/+2
| | | | | | | | Avoid conflicts in the protocol documentation by pointing back to the reference implementation. Change-Id: I380f32dab2e9b8bbeec25b9abffe9c5427b76bd3 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* docs: Add suggested timeout response argument to GET_MBOX_INFOSuraj Jitindar Singh2017-05-031-0/+9
| | | | | | | | | | | | | | | | | It would be nice to suggest to the host how long it should wait for a response to a command before assuming that the BMC is not going to respond and timing out. Add a response argument for this to the GET_MBOX_INFO command. We don't want to require a BMC to set this so we allow it to be zero to indicate that no suggestion has been given. This doesn't require us to bump the protocol number since the current daemon just sets this to zero (which is allowed) and the host is free to ignore this, which it currently does. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: Idd65a5660e0092b9abd98829403b981fd26f8bbe
* docs: Stipulate register 13 must be written last when writing a responseSuraj Jitindar Singh2017-05-031-0/+7
| | | | | | | | | | | | | | | Writes to register 13 (Response Code) are what is used to generate an interrupt to the host. On receiving this interrupt the host can start processing the entire response message. Thus to ensure that the host is processing the correct mbox response register 13 must be the last to be written. Stipulate in the protocol documentation that the last register to be written by the BMC when writing a response must be the response code into register 13. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: I2b4e14a81d7bbffc990cfb83321ab219e3df1d82
* docs: Stipulate that block size must be >= 4K and a power-of-2Suraj Jitindar Singh2017-05-031-2/+13
| | | | | | | | | | | | | | | | | Arguments and responses to most commands are given in block size which is decided on during the version negotiation process when GET_MBOX_INFO is called. We require that block size is greater than 4K (12 bit). The lpc bus address space is 28 bit and commands which return an lpc bus address have a 16 bit variable space, this means we can correctly specify anywhere in the lpc address space. This also allows us to support flash sizes up to 256MB where we can correctly specify any flash offset in the command arguments. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: Ia08979017a3c0ff229ce412948dc4c67d357e82b
* docs: Reword create_{read/write}_window command specSuraj Jitindar Singh2017-05-031-19/+15
| | | | | | | | | Reword the create_{read/write}_window command specification to make it easier to understand and remove sentences which add no value or are unnecessarily verbose. Signed-off-by: Suraj Jitindar Singh <sjitindarsingh@gmail.com> Change-Id: Idb1ac8da82d4a1ab379c55ff650ef410de86e715
* mbox: Clarify sequence number constraintsAndrew Jeffery2017-04-261-16/+28
| | | | | | | And implement the specified behaviour. Change-Id: I268d5896aa8dda3875cd79f4ff18929c8e3aea49 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* mbox: 'regsiter' typo in protocol documentationAndrew Jeffery2017-04-241-1/+1
| | | | | Change-Id: Ic78359102aae580dadb4de782f7ea025aaa3f4ad Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* mbox: Clarify protocol version negotionAndrew Jeffery2017-04-241-10/+11
| | | | | | | | | | | | | The specification intended that the mbox daemon return its highest supported protocol version less-than-or-equal to the version requested by the host. This was not clear in the documentation and was not the behaviour implemented by the daemon. Fix both the documentation and the daemon to perform to this expectation. Change-Id: I6f9cf0b16d2b9319d69656eb26defb46dccd4ddf Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* docs: Create Documentation folder and add mboxd and mboxctl documentationSuraj Jitindar Singh2017-04-113-0/+944
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
OpenPOWER on IntegriCloud