blob: 49bf90e4e8721603e83c9faaaeb44232a57aa65b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
Copyright 2017 IBM
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Intro
This document describes the reference mailbox control program contained in this
repository.
The mailbox control program is a program which can be used to generate dbus
messages to control the operation of the mailbox daemon.
## Files
The mailbox control program is implemented entirely in the mboxctl.c file.
## Operation
### Invocation
The mailbox control program is invoked with a command and any arguments which
that command takes.
### Sending Command
The appropriate dbus message is then generated and sent on the dbus.
### Receiving Commands
After sending a command mboxctl then waits for a response from the daemon on
the dbus and processes the response.
A message is printed to convey the response provided by the daemon. It mboxctl
is run in silent mode then no output is generated and the exit code reflects
the response.
## DBUS Protocol
### Commands
```
0x00: Ping - Ping the daemon
- Args: NONE
- Resp: NONE
0x01: Daemon State - Get the daemon status
- Args: NONE
- Resp[0]: Daemon Status:
0x00 - Active
0x01 - Suspended
0x02: Reset - Reset the daemon (same as the reset mbox command)
- Args: NONE
- Resp: NONE
0x03: Suspend - Suspend the daemon
- Allow the BMC to manage concurrent flash
access
- The daemon will return BUSY to mbox window
commands
- Will return Success if daemon successfully
of already suspended
- Args: NONE
- Resp: NONE
0x04: Resume - Resume the daemon
- Will return Sucess if daemon successfully
or already resumed
- Args[0]: Flash Modified:
"clean" - Not Modified (daemon won't
clear its cache)
"modified" - Modified (daemon will clear
its cache)
- Resp: NONE
0x05: Clear Cache - Tell the daemon its data source has been modified
- Causes the daemon to clear its cache
- Args: NONE
- Resp: NONE
0x06: Kill - Terminates the daemon
- Args: NONE
- Resp: NONE
0x07: LPC State - Query the state of the lpc mapping
- Args: NONE
- Resp[0]: LPC Bus Mapping State:
0x00 - Invalid (implies internal daemon
error)
0x01 - Flash (LPC bus maps flash)
0x02 - Memory (LPC bus maps reserved
memory)
```
### Return Values
```
0x00: Success - Command succeeded
0x01: Internal - Internal DBUS Error
0x02: Invalid - Invalid command or parameters
0x03: Rejected - Daemon rejected the request
- If this occurs on a suspend command then the BMC must
not access the flash device until a suspend command
succeeds
0x04: Hardware - BMC Hardware Error
0x05: Memory - Memory Allocation Failed
```
|
