| 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, | 
| P Arun Kumar Reddy | e090c78 | 2025-03-14 14:34:18 +0530 | [diff] [blame] | 62 | value: 0, | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 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 |  | 
| P Arun Kumar Reddy | 6fa09e9 | 2025-04-25 11:24:06 +0530 | [diff] [blame] | 131 | option( | 
|  | 132 | 'update-timeout-seconds', | 
|  | 133 | type: 'integer', | 
|  | 134 | min: 60, | 
|  | 135 | max: 90, | 
|  | 136 | value: 60, | 
|  | 137 | description: '''Timeout in seconds for the UA to cancel the component update | 
|  | 138 | if no command is received from the FD during component image | 
|  | 139 | transfer stage''', | 
|  | 140 | ) | 
|  | 141 |  | 
| Archana Kakani | 46f352e | 2024-03-17 08:21:08 -0500 | [diff] [blame] | 142 | # Bios Attributes option | 
|  | 143 | option( | 
|  | 144 | 'system-specific-bios-json', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 145 | type: 'feature', | 
| Archana Kakani | 46f352e | 2024-03-17 08:21:08 -0500 | [diff] [blame] | 146 | value: 'disabled', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 147 | 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] | 148 | ) | 
|  | 149 |  | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 150 | # PLDM Soft Power off options | 
|  | 151 | option( | 
|  | 152 | 'softoff', | 
|  | 153 | type: 'feature', | 
|  | 154 | value: 'enabled', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 155 | description: 'Build soft power off application', | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 156 | ) | 
|  | 157 |  | 
|  | 158 | option( | 
|  | 159 | 'softoff-timeout-seconds', | 
|  | 160 | type: 'integer', | 
|  | 161 | value: 7200, | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 162 | description: 'softoff: Time to wait for host to gracefully shutdown', | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 163 | ) | 
|  | 164 |  | 
|  | 165 | # Vendor Specific Options | 
|  | 166 |  | 
|  | 167 | ## OEM IBM Options | 
|  | 168 | option( | 
|  | 169 | 'oem-ibm', | 
|  | 170 | type: 'feature', | 
|  | 171 | value: 'enabled', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 172 | description: 'Enable IBM OEM PLDM', | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 173 | ) | 
|  | 174 |  | 
|  | 175 | option( | 
|  | 176 | 'oem-ibm-dma-maxsize', | 
|  | 177 | type: 'integer', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 178 | min: 4096, | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 179 | max: 16773120, | 
|  | 180 | value: 8384512, | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 181 | description: 'OEM-IBM: max DMA size', | 
| Manojkiran Eda | e8fd5fb | 2023-07-14 18:39:08 +0530 | [diff] [blame] | 182 | ) | 
| Thu Nguyen | 3c5486d | 2024-08-01 08:03:08 +0000 | [diff] [blame] | 183 |  | 
| Chau Ly | a743e38 | 2024-10-26 11:12:22 +0000 | [diff] [blame] | 184 |  | 
|  | 185 | ## OEM AMPERE Options | 
|  | 186 | option( | 
|  | 187 | 'oem-ampere', | 
|  | 188 | type: 'feature', | 
|  | 189 | description: 'Enable AMPERE OEM PLDM', | 
| Patrick Williams | 79e097c | 2024-11-06 13:44:04 -0500 | [diff] [blame] | 190 | value: 'enabled', | 
| Chau Ly | a743e38 | 2024-10-26 11:12:22 +0000 | [diff] [blame] | 191 | ) | 
|  | 192 |  | 
| Thu Nguyen | 3c5486d | 2024-08-01 08:03:08 +0000 | [diff] [blame] | 193 | ## Default Sensor Update Interval Options | 
|  | 194 | option( | 
|  | 195 | 'default-sensor-update-interval', | 
|  | 196 | type: 'integer', | 
|  | 197 | min: 1, | 
|  | 198 | max: 4294967295, | 
|  | 199 | description: '''The default sensor polling interval in milliseconds. | 
|  | 200 | The value will be used when the internal is not configured | 
|  | 201 | in the PLDM sensor PDRs use `updateInterval` field. `pldmd` | 
|  | 202 | will send `GetSensorReading` to get the PLDM sensor values | 
|  | 203 | of the monitoring terminus after each configured | 
|  | 204 | interval.''', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 205 | value: 999, | 
| Gilbert Chen | eac61a4 | 2022-02-23 20:56:19 +0000 | [diff] [blame] | 206 | ) | 
|  | 207 |  | 
|  | 208 | # Platform-mc configuration parameters | 
|  | 209 |  | 
|  | 210 | ## Sensor Polling Options | 
|  | 211 | option( | 
|  | 212 | 'sensor-polling-time', | 
|  | 213 | type: 'integer', | 
|  | 214 | min: 1, | 
|  | 215 | max: 10000, | 
|  | 216 | description: '''The configured timeout in milliseconds of the common sensor | 
|  | 217 | polling timer of each terminus which will trigger the | 
|  | 218 | terminus sensor reading task. The task will check | 
|  | 219 | whether the sensor in the terminus sensors list need to | 
|  | 220 | be updated by comparing the sensor `updateInterval` with the | 
|  | 221 | interval between current timestamp and latest updated | 
|  | 222 | timestamp of the sensor. The task will send | 
|  | 223 | `GetSensorReading` if the sensor need to be updated.''', | 
| Patrick Williams | 9b40260 | 2025-02-01 08:37:20 -0500 | [diff] [blame] | 224 | value: 249, | 
| Gilbert Chen | eac61a4 | 2022-02-23 20:56:19 +0000 | [diff] [blame] | 225 | ) |