1 #pragma once 2 3 #include <filesystem> 4 #include <string> 5 #include <vector> 6 7 namespace phosphor 8 { 9 namespace pmbus 10 { 11 12 namespace fs = std::filesystem; 13 14 // The file name Linux uses to capture the STATUS_WORD from pmbus. 15 constexpr auto STATUS_WORD = "status0"; 16 17 // The file name Linux uses to capture the STATUS_INPUT from pmbus. 18 constexpr auto STATUS_INPUT = "status0_input"; 19 20 // Voltage out status. 21 // Overvoltage fault or warning, Undervoltage fault or warning, maximum or 22 // minimum warning, .... 23 // Uses Page substitution 24 constexpr auto STATUS_VOUT = "statusP_vout"; 25 26 namespace status_vout 27 { 28 // Mask of bits that are only warnings 29 constexpr auto WARNING_MASK = 0x6A; 30 } // namespace status_vout 31 32 // Current output status bits. 33 constexpr auto STATUS_IOUT = "status0_iout"; 34 35 // Manufacturing specific status bits 36 constexpr auto STATUS_MFR = "status0_mfr"; 37 38 // Reports on the status of any fans installed in position 1 and 2. 39 constexpr auto STATUS_FANS_1_2 = "status0_fans12"; 40 41 // Reports on temperature faults or warnings. Overtemperature fault, 42 // overtemperature warning, undertemperature warning, undertemperature fault. 43 constexpr auto STATUS_TEMPERATURE = "status0_temp"; 44 45 namespace status_word 46 { 47 constexpr auto VOUT_FAULT = 0x8000; 48 49 // The IBM CFF power supply driver does map this bit to power1_alarm in the 50 // hwmon space, but since the other bits that need to be checked do not have 51 // a similar mapping, the code will just read STATUS_WORD and use bit masking 52 // to see if the INPUT FAULT OR WARNING bit is on. 53 constexpr auto INPUT_FAULT_WARN = 0x2000; 54 55 // The bit mask representing the MFRSPECIFIC fault, bit 4 of STATUS_WORD high 56 // byte. A manufacturer specific fault or warning has occurred. 57 constexpr auto MFR_SPECIFIC_FAULT = 0x1000; 58 59 // The bit mask representing the POWER_GOOD Negated bit of the STATUS_WORD. 60 constexpr auto POWER_GOOD_NEGATED = 0x0800; 61 62 // The bit mask representing the FAN FAULT or WARNING bit of the STATUS_WORD. 63 // Bit 2 of the high byte of STATUS_WORD. 64 constexpr auto FAN_FAULT = 0x0400; 65 66 // The bit mask representing the UNITI_IS_OFF bit of the STATUS_WORD. 67 constexpr auto UNIT_IS_OFF = 0x0040; 68 69 // Bit 5 of the STATUS_BYTE, or lower byte of STATUS_WORD is used to indicate 70 // an output overvoltage fault. 71 constexpr auto VOUT_OV_FAULT = 0x0020; 72 73 // The bit mask representing that an output overcurrent fault has occurred. 74 constexpr auto IOUT_OC_FAULT = 0x0010; 75 76 // The IBM CFF power supply driver does map this bit to in1_alarm, however, 77 // since a number of the other bits are not mapped that way for STATUS_WORD, 78 // this code will just read the entire STATUS_WORD and use bit masking to find 79 // out if that fault is on. 80 constexpr auto VIN_UV_FAULT = 0x0008; 81 82 // The bit mask representing the TEMPERATURE FAULT or WARNING bit of the 83 // STATUS_WORD. Bit 2 of the low byte (STATUS_BYTE). 84 constexpr auto TEMPERATURE_FAULT_WARN = 0x0004; 85 86 } // namespace status_word 87 88 namespace status_vout 89 { 90 // The IBM CFF power supply driver maps MFR's OV_FAULT and VAUX_FAULT to this 91 // bit. 92 constexpr auto OV_FAULT = 0x80; 93 94 // The IBM CFF power supply driver maps MFR's UV_FAULT to this bit. 95 constexpr auto UV_FAULT = 0x10; 96 } // namespace status_vout 97 98 namespace status_temperature 99 { 100 // Overtemperature Fault 101 constexpr auto OT_FAULT = 0x80; 102 } // namespace status_temperature 103 104 constexpr auto ON_OFF_CONFIG = "on_off_config"; 105 106 // From PMBus Specification Part II Revsion 1.2: 107 // The ON_OFF_CONFIG command configures the combination of CONTROL pin input 108 // and serial bus commands needed to turn the unit on and off. This includes how 109 // the unit responds when power is applied. 110 // Bits [7:5] - 000 - Reserved 111 // Bit 4 - 1 - Unit does not power up until commanded by the CONTROL pin and 112 // OPERATION command (as programmed in bits [3:0]). 113 // Bit 3 - 0 - Unit ignores the on/off portion of the OPERATION command from 114 // serial bus. 115 // Bit 2 - 1 - Unit requires the CONTROL pin to be asserted to start the unit. 116 // Bit 1 - 0 - Polarity of the CONTROL pin. Active low (Pull pin low to start 117 // the unit). 118 // Bit 0 - 1 - Turn off the output and stop transferring energy to the output as 119 // fast as possible. 120 constexpr auto ON_OFF_CONFIG_CONTROL_PIN_ONLY = 0x15; 121 122 /** 123 * Where the access should be done 124 */ 125 enum class Type 126 { 127 Base, // base device directory 128 Hwmon, // hwmon directory 129 Debug, // pmbus debug directory 130 DeviceDebug, // device debug directory 131 HwmonDeviceDebug // hwmon device debug directory 132 }; 133 134 /** 135 * @class PMBusBase 136 * 137 * This is a base class for PMBus to assist with unit testing via mocking. 138 */ 139 class PMBusBase 140 { 141 public: 142 virtual ~PMBusBase() = default; 143 144 virtual uint64_t read(const std::string& name, Type type) = 0; 145 virtual void writeBinary(const std::string& name, std::vector<uint8_t> data, 146 Type type) = 0; 147 }; 148 149 /** 150 * Wrapper function for PMBus 151 * 152 * @param[in] bus - I2C bus 153 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069) 154 * 155 * @return PMBusBase pointer 156 */ 157 std::unique_ptr<PMBusBase> createPMBus(std::uint8_t bus, 158 const std::string& address); 159 160 /** 161 * @class PMBus 162 * 163 * This class is an interface to communicating with PMBus devices 164 * by reading and writing sysfs files. 165 * 166 * Based on the Type parameter, the accesses can either be done 167 * in the base device directory (the one passed into the constructor), 168 * or in the hwmon directory for the device. 169 */ 170 class PMBus : public PMBusBase 171 { 172 public: 173 PMBus() = delete; 174 virtual ~PMBus() = default; 175 PMBus(const PMBus&) = default; 176 PMBus& operator=(const PMBus&) = default; 177 PMBus(PMBus&&) = default; 178 PMBus& operator=(PMBus&&) = default; 179 180 /** 181 * Constructor 182 * 183 * @param[in] path - path to the sysfs directory 184 */ 185 PMBus(const std::string& path) : basePath(path) 186 { 187 findHwmonDir(); 188 } 189 190 /** 191 * Constructor 192 * 193 * This version is required when DeviceDebug 194 * access will be used. 195 * 196 * @param[in] path - path to the sysfs directory 197 * @param[in] driverName - the device driver name 198 * @param[in] instance - chip instance number 199 */ 200 PMBus(const std::string& path, const std::string& driverName, 201 size_t instance) : 202 basePath(path), 203 driverName(driverName), instance(instance) 204 { 205 findHwmonDir(); 206 } 207 208 /** 209 * Wrapper function for PMBus 210 * 211 * @param[in] bus - I2C bus 212 * @param[in] address - I2C address (as a 2-byte string, e.g. 0069) 213 * 214 * @return PMBusBase pointer 215 */ 216 static std::unique_ptr<PMBusBase> createPMBus(std::uint8_t bus, 217 const std::string& address); 218 219 /** 220 * Reads a file in sysfs that represents a single bit, 221 * therefore doing a PMBus read. 222 * 223 * @param[in] name - path concatenated to 224 * basePath to read 225 * @param[in] type - Path type 226 * 227 * @return bool - false if result was 0, else true 228 */ 229 bool readBit(const std::string& name, Type type); 230 231 /** 232 * Reads a file in sysfs that represents a single bit, 233 * where the page number passed in is substituted 234 * into the name in place of the 'P' character in it. 235 * 236 * @param[in] name - path concatenated to 237 * basePath to read 238 * @param[in] page - page number 239 * @param[in] type - Path type 240 * 241 * @return bool - false if result was 0, else true 242 */ 243 bool readBitInPage(const std::string& name, size_t page, Type type); 244 /** 245 * Checks if the file for the given name and type exists. 246 * 247 * @param[in] name - path concatenated to basePath to read 248 * @param[in] type - Path type 249 * 250 * @return bool - True if file exists, false if it does not. 251 */ 252 bool exists(const std::string& name, Type type); 253 254 /** 255 * Read byte(s) from file in sysfs. 256 * 257 * @param[in] name - path concatenated to basePath to read 258 * @param[in] type - Path type 259 * 260 * @return uint64_t - Up to 8 bytes of data read from file. 261 */ 262 uint64_t read(const std::string& name, Type type) override; 263 264 /** 265 * Read a string from file in sysfs. 266 * 267 * @param[in] name - path concatenated to basePath to read 268 * @param[in] type - Path type 269 * 270 * @return string - The data read from the file. 271 */ 272 std::string readString(const std::string& name, Type type); 273 274 /** 275 * Read data from a binary file in sysfs. 276 * 277 * @param[in] name - path concatenated to basePath to read 278 * @param[in] type - Path type 279 * @param[in] length - length of data to read, in bytes 280 * 281 * @return vector<uint8_t> - The data read from the file. 282 */ 283 std::vector<uint8_t> readBinary(const std::string& name, Type type, 284 size_t length); 285 286 /** 287 * Writes an integer value to the file, therefore doing 288 * a PMBus write. 289 * 290 * @param[in] name - path concatenated to 291 * basePath to write 292 * @param[in] value - the value to write 293 * @param[in] type - Path type 294 */ 295 void write(const std::string& name, int value, Type type); 296 297 /** 298 * Writes binary data to a file in sysfs. 299 * 300 * @param[in] name - path concatenated to basePath to write 301 * @param[in] data - The data to write to the file 302 * @param[in] type - Path type 303 */ 304 void writeBinary(const std::string& name, std::vector<uint8_t> data, 305 Type type) override; 306 307 /** 308 * Returns the sysfs base path of this device 309 */ 310 inline const auto& path() const 311 { 312 return basePath; 313 } 314 315 /** 316 * Replaces the 'P' in the string passed in with 317 * the page number passed in. 318 * 319 * For example: 320 * insertPageNum("inP_enable", 42) 321 * returns "in42_enable" 322 * 323 * @param[in] templateName - the name string, with a 'P' in it 324 * @param[in] page - the page number to insert where the P was 325 * 326 * @return string - the new string with the page number in it 327 */ 328 static std::string insertPageNum(const std::string& templateName, 329 size_t page); 330 331 /** 332 * Finds the path relative to basePath to the hwmon directory 333 * for the device and stores it in hwmonRelPath. 334 */ 335 void findHwmonDir(); 336 337 /** 338 * Returns the path to use for the passed in type. 339 * 340 * @param[in] type - Path type 341 * 342 * @return fs::path - the full path 343 */ 344 fs::path getPath(Type type); 345 346 private: 347 /** 348 * Returns the device name 349 * 350 * This is found in the 'name' file in basePath. 351 * 352 * @return string - the device name 353 */ 354 std::string getDeviceName(); 355 356 /** 357 * The sysfs device path 358 */ 359 fs::path basePath; 360 361 /** 362 * The directory name under the basePath hwmon directory 363 */ 364 fs::path hwmonDir; 365 366 /** 367 * The device driver name. Used for finding the device 368 * debug directory. Not required if that directory 369 * isn't used. 370 */ 371 std::string driverName; 372 373 /** 374 * The device instance number. 375 * 376 * Used in conjunction with the driver name for finding 377 * the debug directory. Not required if that directory 378 * isn't used. 379 */ 380 size_t instance = 0; 381 382 /** 383 * The pmbus debug path with status files 384 */ 385 const fs::path debugPath = "/sys/kernel/debug/"; 386 }; 387 388 } // namespace pmbus 389 } // namespace phosphor 390