libthinkpad.h

/*
 * Copyright (c) 2017 Ognjen Galić
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef LIBTHINKDOCK_LIBRARY_H
#define LIBTHINKDOCK_LIBRARY_H

#define LIBTHINKPAD_MAJOR 2
#define LIBTHINKPAD_MINOR 6

#include <string>
#include <vector>
#include <cstdio>

#define IBM_DOCK "/sys/devices/platform/dock.2"
#define IBM_DOCK_DOCKED     "/sys/devices/platform/dock.2/docked"
#define IBM_DOCK_MODALIAS   "/sys/devices/platform/dock.2/modalias"
#define IBM_DOCK_ID         "acpi:IBM0079:PNP0C15:LNXDOCK:\n"
#define ERR_INVALID (-1)

// #define DRYRUN

#define ACPI_POWERBUTTON "button/power PBTN"
#define ACPI_LID_OPEN "button/lid LID open"
#define ACPI_LID_CLOSE "button/lid LID close"

#define ACPI_DOCK_EVENT "ibm/hotkey LEN0068:00 00000080 00004010"
#define ACPI_DOCK_EVENT2 "ibm/hotkey LEN0268:00 00000080 00004010"
#define ACPI_UNDOCK_EVENT "ibm/hotkey LEN0068:00 00000080 00004011"
#define ACPI_UNDOCK_EVENT2 "ibm/hotkey LEN0268:00 00000080 00004011"

#define ACPI_BUTTON_BRIGHTNESS_UP "video/brightnessup BRTUP"
#define ACPI_BUTTON_BRIGHTNESS_DOWN "video/brightnessdown BRTDN"
#define ACPI_BUTTON_VOLUME_UP "button/volumeup VOLUP"
#define ACPI_BUTTON_VOLUME_DOWN "button/volumedown VOLDN"
#define ACPI_BUTTON_MICMUTE "button/f20 F20"
#define ACPI_BUTTON_MUTE "button/mute MUTE"
#define ACPI_BUTTON_THINKVANTAGE "button/prog1 PROG1"
#define ACPI_BUTTON_FNF2_LOCK "button/screenlock SCRNLCK"
#define ACPI_BUTTON_FNF3_BATTERY "button/battery BAT"
#define ACPI_BUTTON_FNF4_SLEEP "button/sleep SBTN"
#define ACPI_BUTTON_FNF5_WLAN "button/wlan WLAN"
#define ACPI_BUTTON_FNF7_PROJECTOR "video/switchmode VMOD"
#define ACPI_BUTTON_FNF12_HIBERNATE "button/suspend SUSP"

#define ACPID_SOCK "/var/run/acpid.socket"

#define SYSFS_THINKLIGHT "/sys/class/leds/tpacpi::thinklight/brightness"
#define SYSFS_MACHINECHECK "/sys/devices/system/machinecheck/machinecheck"

#define SYSFS_BACKLIGHT_NVIDIA "/sys/class/backlight/nv_backlight"
#define SYSFS_BACKLIGHT_INTEL "/sys/class/backlight/intel_backlight"

#define SYSFS_BATTERY_PRIMARY   "/sys/class/power_supply/BAT0"
#define SYSFS_BATTERY_SECONDARY "/sys/class/power_supply/BAT1"

#define BUFSIZE 128
#define INBUFSZ 1

using std::string;
using std::vector;

typedef int SUSPEND_REASON;
typedef int STATUS;

namespace ThinkPad {

    namespace Hardware {

        class Dock {

        public:

            bool isDocked();

            bool probe();

        };


        class ThinkLight {
        public:
            bool isOn();

            bool probe();

        };
        
        class Backlight {
        private:

            enum System {
                NVIDIA, INTEL
            };

            int getMaxBrightness(System system);
            int getCurrentBrightness(System system);
            void setBrightness(System system, int value);

        public:

            void setBacklightLevel(float factor);

            float getBacklightLevel();
        };
#if 0

        /* Disabled the BM API, the patch is not in mainline yet.
         * https://patchwork.kernel.org/patch/10142173/
         */

        class BatteryManager {
        public:

            enum BatteryID {
                BATTERY_PRIMARY,
                BATTERY_SECONDARY
            };

            int getChargeStartThreshold(BatteryID battery);

            int getChargeStopThreshold(BatteryID battery);

            int setChargeStopThreshold(BatteryID battery, int value);

            int setChargeStartThreshold(BatteryID battery, int value);

            bool probe(BatteryID battery);

            const char *getFRU(BatteryID battery);
            const char *getOEM(BatteryID battery);

        };
#endif

    }



    namespace PowerManagement {

        class PowerStateManager;
        class ACPIEventHandler;
        class ACPI;

        enum ACPIEvent {

            POWER_S3S4_ENTER,

            POWER_S3S4_EXIT,

            LID_CLOSED,

            LID_OPENED,

            DOCKED,

            UNDOCKED,

            BUTTON_POWER,

            BUTTON_VOLUME_UP,

            BUTTON_VOLUME_DOWN,

            BUTTON_MICMUTE,

            BUTTON_MUTE,

            BUTTON_THINKVANTAGE,

            BUTTON_FNF2_LOCK,

            BUTTON_FNF3_BATTERY,

            BUTTON_FNF4_SLEEP,

            BUTTON_FNF5_WLAN,

            BUTTON_FNF7_PROJECTOR,

            BUTTON_FNF12_SUSPEND,

            UNKNOWN,

            /*
             * The brightness decrease button on the ThinkPad has been pressed
             */
            BUTTON_BRIGHTNESS_DOWN,

            /*
             * The brightness increase button on the ThinkPad has been pressed
             */
            BUTTON_BRIGHTNESS_UP
        };

        enum SuspendReason {
            LID,
            BUTTON
        };

        struct _ACPIEventMetadata {
            ACPIEvent event;
            ACPIEventHandler *handler;
        };

        typedef struct _ACPIEventMetadata ACPIEventMetadata;

        class PowerStateManager {

        private:

            static bool suspend();

        public:
            static bool requestSuspend(SuspendReason reason);

        };

        class ACPI {
        private:

            static void *handle_acpid(void*);
            static void *handle_udev(void*);

            static pthread_t acpid_listener;
            static pthread_t udev_listener;

            vector<ACPIEventHandler*> *ACPIhandlers;

            bool udev_running = true;

        public:

            ACPI();
            ~ACPI();

            void addEventHandler(ACPIEventHandler *handler);

            void wait();

            void start();
        };


        class ACPIEventHandler {
        public:
            static void* _handleEvent(void* _this);

            virtual void handleEvent(ACPIEvent event) = 0;
        };

    }


    namespace Utilities {

        namespace Ini {

            class IniKeypair
            {
            public:

                char key[128];
                char value[128];

                IniKeypair(const char *key, const char *value);
                IniKeypair();

            };


            class IniSection
            {
            public:

                ~IniSection();

                IniSection();

                IniSection(const char *name);

                char name[128];
                vector<IniKeypair*> *keypairs = nullptr;

                const char *getString(const char *key) const;

                const void setString(const char *key, const char *value);

                const int getInt(const char *key) const;

                const void setInt(const char *key, const int value);

                const vector<int> getIntArray(const char *key) const;

                const void setIntArray(const char *key, vector<int> *values);

                const void setStringArray(const char *key, const vector<const char*> *strings);

                const vector<const char*> getStringArray(const char *key);
            };


            class Ini
            {
                vector<IniSection*> *sections = new vector<IniSection*>;

            public:
                ~Ini();

                vector<IniSection*>* readIni(string path);

                bool writeIni(string path);


                vector<IniSection*> getSections(const char *section);

                IniSection* getSection(const char *section);

                void addSection(IniSection* section);
            };

        }

        class Versioning {
        public:

            static int getMajorVersion() {
                return LIBTHINKPAD_MAJOR;
            }

            static int getMinorVersion() {
                return LIBTHINKPAD_MINOR;
            }

        };

        class CommonUtils {
        public:
            static const char *fileRead(const char *path);
            static const int intRead(const char *path);
            static int intWrite(const char *path, int value);
        };

    }

}


#endif