xref: /openbmc/phosphor-led-sysfs/sysfs.hpp (revision 1c4503e7)
1 /**
2  * Copyright © 2019 IBM Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #pragma once
18 #include <filesystem>
19 
20 namespace phosphor
21 {
22 namespace led
23 {
24 class SysfsLed
25 {
26   public:
27     explicit SysfsLed(std::filesystem::path&& root) : root(std::move(root)) {}
28     SysfsLed() = delete;
29     SysfsLed(const SysfsLed& other) = delete;
30     SysfsLed(const SysfsLed&& other) = delete;
31     SysfsLed& operator=(const SysfsLed& other) = delete;
32     SysfsLed&& operator=(const SysfsLed&& other) = delete;
33 
34     virtual ~SysfsLed() = default;
35 
36     virtual unsigned long getBrightness();
37     virtual void setBrightness(unsigned long brightness);
38     virtual unsigned long getMaxBrightness();
39     virtual std::string getTrigger();
40     virtual void setTrigger(const std::string& trigger);
41     virtual unsigned long getDelayOn();
42     virtual void setDelayOn(unsigned long ms);
43     virtual unsigned long getDelayOff();
44     virtual void setDelayOff(unsigned long ms);
45 
46   protected:
47     static constexpr const char* attrBrightness = "brightness";
48     static constexpr const char* attrMaxBrightness = "max_brightness";
49     static constexpr const char* attrTrigger = "trigger";
50     static constexpr const char* attrDelayOn = "delay_on";
51     static constexpr const char* attrDelayOff = "delay_off";
52 
53     std::filesystem::path root;
54 };
55 } // namespace led
56 } // namespace phosphor
57