Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 1 | #pragma once |
| 2 | |
| 3 | #include <memory> |
| 4 | #include <string> |
| 5 | |
Lei YU | ab09332 | 2019-10-09 16:43:22 +0800 | [diff] [blame] | 6 | namespace phosphor |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 7 | { |
| 8 | namespace power |
| 9 | { |
| 10 | |
| 11 | /** |
| 12 | * @class Device |
| 13 | * |
| 14 | * This object is an abstract base class for a device that |
| 15 | * can be monitored for power faults. |
| 16 | */ |
| 17 | class Device |
| 18 | { |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 19 | public: |
| 20 | Device() = delete; |
| 21 | virtual ~Device() = default; |
| 22 | Device(const Device&) = delete; |
| 23 | Device& operator=(const Device&) = delete; |
| 24 | Device(Device&&) = default; |
| 25 | Device& operator=(Device&&) = default; |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 26 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 27 | /** |
| 28 | * Constructor |
| 29 | * |
| 30 | * @param name - the device name |
| 31 | * @param inst - the device instance |
| 32 | */ |
| 33 | Device(const std::string& name, size_t inst) : name(name), instance(inst) |
| 34 | { |
| 35 | } |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 36 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 37 | /** |
| 38 | * Returns the instance number |
| 39 | */ |
| 40 | inline auto getInstance() const |
| 41 | { |
| 42 | return instance; |
| 43 | } |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 44 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 45 | /** |
| 46 | * Returns the name |
| 47 | */ |
| 48 | inline auto getName() const |
| 49 | { |
| 50 | return name; |
| 51 | } |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 52 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 53 | /** |
| 54 | * Pure virtual function to analyze an error |
| 55 | */ |
| 56 | virtual void analyze() = 0; |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 57 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 58 | /** |
| 59 | * Stubbed virtual function to call when it's known |
| 60 | * the chip is in error state. Override if functionality |
| 61 | * is required |
| 62 | */ |
| 63 | virtual void onFailure() |
| 64 | { |
| 65 | } |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 66 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 67 | /** |
| 68 | * Pure virtual function to clear faults on the device |
| 69 | */ |
| 70 | virtual void clearFaults() = 0; |
Matt Spinler | b54357f | 2017-08-21 14:38:54 -0500 | [diff] [blame] | 71 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 72 | private: |
| 73 | /** |
| 74 | * the device name |
| 75 | */ |
| 76 | const std::string name; |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 77 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 78 | /** |
| 79 | * the device instance number |
| 80 | */ |
| 81 | const size_t instance; |
Matt Spinler | dae0a8d | 2017-07-24 13:42:55 -0500 | [diff] [blame] | 82 | }; |
| 83 | |
Matt Spinler | f0f02b9 | 2018-10-25 16:12:43 -0500 | [diff] [blame] | 84 | } // namespace power |
Lei YU | ab09332 | 2019-10-09 16:43:22 +0800 | [diff] [blame] | 85 | } // namespace phosphor |