Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 1 | # PLDM daemon options |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 2 | option('tests', type: 'feature', value: 'enabled', description: 'Build tests') |
Lei YU | 31fc47e | 2020-02-27 11:41:45 +0800 | [diff] [blame] | 3 | |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 4 | option( |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 5 | 'utilities', |
| 6 | type: 'feature', |
| 7 | value: 'enabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 8 | description: 'Enable debug utilities', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 9 | ) |
Brad Bishop | adbb245 | 2021-08-19 16:33:53 -0400 | [diff] [blame] | 10 | |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 11 | option( |
| 12 | 'libpldmresponder', |
| 13 | type: 'feature', |
| 14 | value: 'enabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 15 | description: 'Enable libpldmresponder', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 16 | ) |
Sagar Srinivas | a6a8ccd | 2021-04-01 07:58:33 -0500 | [diff] [blame] | 17 | |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 18 | option( |
| 19 | 'systemd', |
| 20 | type: 'feature', |
| 21 | value: 'enabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 22 | description: 'Include systemd support', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 23 | ) |
Manojkiran Eda | cc5f158 | 2021-09-29 17:03:06 +0530 | [diff] [blame] | 24 | |
Rashmica Gupta | 1ed5f7a | 2023-05-22 13:56:42 +1000 | [diff] [blame] | 25 | option( |
| 26 | 'transport-implementation', |
| 27 | type: 'combo', |
| 28 | choices: ['mctp-demux', 'af-mctp'], |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 29 | description: 'transport via af-mctp or mctp-demux', |
Rashmica Gupta | 1ed5f7a | 2023-05-22 13:56:42 +1000 | [diff] [blame] | 30 | ) |
| 31 | |
vkaverap@in.ibm.com | c0b0e7b | 2023-07-18 00:06:40 -0500 | [diff] [blame] | 32 | # As per PLDM spec DSP0240 version 1.1.0, in Timing Specification for PLDM messages (Table 6), |
| 33 | # the instance ID for a given response will expire and become reusable if a response has not been |
| 34 | # received within a maximum of 6 seconds after a request is sent. By setting the dbus timeout |
| 35 | # value to 5 seconds we ensure that PLDM does not wait for a response from a dbus call even after |
| 36 | # the instance ID has expired. If the option is set to 5 seconds, any dbus call originated from |
| 37 | # PLDM daemon will timeout after 5 seconds. |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 38 | option( |
| 39 | 'dbus-timeout-value', |
| 40 | type: 'integer', |
| 41 | min: 3, |
| 42 | max: 10, |
| 43 | value: 5, |
| 44 | description: '''The amount of time pldm waits to get a response for a dbus |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 45 | message before timing out''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 46 | ) |
| 47 | |
| 48 | option( |
| 49 | 'heartbeat-timeout-seconds', |
| 50 | type: 'integer', |
| 51 | value: 120, |
| 52 | description: '''The amount of time host waits for BMC to respond to pings |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 53 | from host, as part of host-bmc surveillance''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 54 | ) |
| 55 | |
| 56 | # Flight Recorder for PLDM Daemon |
| 57 | option( |
| 58 | 'flightrecorder-max-entries', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 59 | type: 'integer', |
| 60 | min: 0, |
| 61 | max: 30, |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 62 | value: 10, |
| 63 | description: '''The max number of pldm messages that can be stored in the |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 64 | recorder, this feature will be disabled if it is set to 0''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 65 | ) |
| 66 | |
| 67 | # PLDM Daemon Terminus options |
| 68 | option( |
| 69 | 'terminus-id', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 70 | type: 'integer', |
| 71 | min: 0, |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 72 | max: 255, |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 73 | value: 1, |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 74 | description: '''The terminus id value of the device that is running this |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 75 | pldm stack''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 76 | ) |
| 77 | |
| 78 | option( |
| 79 | 'terminus-handle', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 80 | type: 'integer', |
| 81 | min: 0, |
| 82 | max: 65535, |
| 83 | value: 1, |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 84 | description: '''The terminus handle value of the device that is running this |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 85 | pldm stack''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 86 | ) |
| 87 | |
| 88 | # Timing specification options for PLDM messages |
| 89 | option( |
| 90 | 'number-of-request-retries', |
| 91 | type: 'integer', |
| 92 | min: 2, |
| 93 | max: 30, |
| 94 | value: 2, |
| 95 | description: '''The number of times a requester is obligated to retry a |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 96 | request''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 97 | ) |
| 98 | |
| 99 | option( |
| 100 | 'instance-id-expiration-interval', |
| 101 | type: 'integer', |
| 102 | min: 5, |
| 103 | max: 6, |
| 104 | value: 5, |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 105 | description: 'Instance ID expiration interval in seconds', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 106 | ) |
| 107 | |
| 108 | # Default response-time-out set to 2 seconds to facilitate a minimum retry of |
| 109 | # the request of 2. |
| 110 | option( |
| 111 | 'response-time-out', |
| 112 | type: 'integer', |
| 113 | min: 300, |
| 114 | max: 4800, |
| 115 | value: 2000, |
| 116 | description: '''The amount of time a requester has to wait for a response |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 117 | message in milliseconds''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 118 | ) |
Manojkiran Eda | cc5f158 | 2021-09-29 17:03:06 +0530 | [diff] [blame] | 119 | |
Tom Joseph | ef90b0d | 2021-08-17 07:12:49 -0700 | [diff] [blame] | 120 | # Firmware update configuration parameters |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 121 | option( |
| 122 | 'maximum-transfer-size', |
| 123 | type: 'integer', |
| 124 | min: 16, |
| 125 | max: 4294967295, |
| 126 | value: 4096, |
| 127 | description: '''Maximum size in bytes of the variable payload allowed to be |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 128 | requested by the FD, via RequestFirmwareData command''', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 129 | ) |
| 130 | |
Archana Kakani | 46f352e | 2024-03-17 08:21:08 -0500 | [diff] [blame] | 131 | # Bios Attributes option |
| 132 | option( |
| 133 | 'system-specific-bios-json', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 134 | type: 'feature', |
Archana Kakani | 46f352e | 2024-03-17 08:21:08 -0500 | [diff] [blame] | 135 | value: 'disabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 136 | description: 'Support for different set of bios attributes for different types of systems', |
Archana Kakani | 46f352e | 2024-03-17 08:21:08 -0500 | [diff] [blame] | 137 | ) |
| 138 | |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 139 | # PLDM Soft Power off options |
| 140 | option( |
| 141 | 'softoff', |
| 142 | type: 'feature', |
| 143 | value: 'enabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 144 | description: 'Build soft power off application', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 145 | ) |
| 146 | |
| 147 | option( |
| 148 | 'softoff-timeout-seconds', |
| 149 | type: 'integer', |
| 150 | value: 7200, |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 151 | description: 'softoff: Time to wait for host to gracefully shutdown', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 152 | ) |
| 153 | |
| 154 | # Vendor Specific Options |
| 155 | |
| 156 | ## OEM IBM Options |
| 157 | option( |
| 158 | 'oem-ibm', |
| 159 | type: 'feature', |
| 160 | value: 'enabled', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 161 | description: 'Enable IBM OEM PLDM', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 162 | ) |
| 163 | |
| 164 | option( |
| 165 | 'oem-ibm-dma-maxsize', |
| 166 | type: 'integer', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 167 | min: 4096, |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 168 | max: 16773120, |
| 169 | value: 8384512, |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 170 | description: 'OEM-IBM: max DMA size', |
Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 171 | ) |
Thu Nguyen | 3c5486d | 2024-08-01 08:03:08 +0000 | [diff] [blame] | 172 | |
Chau Ly | a743e38 | 2024-10-26 11:12:22 +0000 | [diff] [blame] | 173 | |
| 174 | ## OEM AMPERE Options |
| 175 | option( |
| 176 | 'oem-ampere', |
| 177 | type: 'feature', |
| 178 | description: 'Enable AMPERE OEM PLDM', |
Patrick Williams | 79e097c | 2024-11-06 13:44:04 -0500 | [diff] [blame] | 179 | value: 'enabled', |
Chau Ly | a743e38 | 2024-10-26 11:12:22 +0000 | [diff] [blame] | 180 | ) |
| 181 | |
Thu Nguyen | 3c5486d | 2024-08-01 08:03:08 +0000 | [diff] [blame] | 182 | ## Default Sensor Update Interval Options |
| 183 | option( |
| 184 | 'default-sensor-update-interval', |
| 185 | type: 'integer', |
| 186 | min: 1, |
| 187 | max: 4294967295, |
| 188 | description: '''The default sensor polling interval in milliseconds. |
| 189 | The value will be used when the internal is not configured |
| 190 | in the PLDM sensor PDRs use `updateInterval` field. `pldmd` |
| 191 | will send `GetSensorReading` to get the PLDM sensor values |
| 192 | of the monitoring terminus after each configured |
| 193 | interval.''', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 194 | value: 999, |
Gilbert Chen | eac61a4 | 2022-02-23 20:56:19 +0000 | [diff] [blame] | 195 | ) |
| 196 | |
| 197 | # Platform-mc configuration parameters |
| 198 | |
| 199 | ## Sensor Polling Options |
| 200 | option( |
| 201 | 'sensor-polling-time', |
| 202 | type: 'integer', |
| 203 | min: 1, |
| 204 | max: 10000, |
| 205 | description: '''The configured timeout in milliseconds of the common sensor |
| 206 | polling timer of each terminus which will trigger the |
| 207 | terminus sensor reading task. The task will check |
| 208 | whether the sensor in the terminus sensors list need to |
| 209 | be updated by comparing the sensor `updateInterval` with the |
| 210 | interval between current timestamp and latest updated |
| 211 | timestamp of the sensor. The task will send |
| 212 | `GetSensorReading` if the sensor need to be updated.''', |
Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 213 | value: 249, |
Gilbert Chen | eac61a4 | 2022-02-23 20:56:19 +0000 | [diff] [blame] | 214 | ) |