From 50ec1095c1901f5d646dfcd64e7a4c47600ac308 Mon Sep 17 00:00:00 2001 From: Adam Honse Date: Thu, 16 May 2024 22:06:29 -0500 Subject: [PATCH] Update ENE SMBus controller files to new standardized header comment --- .../ENESMBusController/ENESMBusController.cpp | 23 ++++++++-------- .../ENESMBusController/ENESMBusController.h | 26 +++++++++---------- .../ENESMBusControllerDetect.cpp | 15 ++++++++--- .../ENESMBusInterface/ENESMBusInterface.h | 21 ++++++++------- .../ENESMBusInterface_ROGArion.cpp | 17 +++++++----- .../ENESMBusInterface_ROGArion.h | 18 +++++++------ .../ENESMBusInterface_SpectrixS40G_Linux.cpp | 24 +++++++++-------- .../ENESMBusInterface_SpectrixS40G_Linux.h | 22 +++++++++------- ...ENESMBusInterface_SpectrixS40G_Windows.cpp | 25 +++++++++--------- .../ENESMBusInterface_SpectrixS40G_Windows.h | 25 +++++++++--------- .../ENESMBusInterface_i2c_smbus.cpp | 17 +++++++----- .../ENESMBusInterface_i2c_smbus.h | 22 +++++++++------- .../RGBController_ENESMBus.cpp | 17 +++++++----- .../RGBController_ENESMBus.h | 17 +++++++----- .../ENESMBusController/ROGArionDetect.cpp | 12 +++++++-- .../XPGSpectrixS40GDetect_Linux.cpp | 22 +++++++++++----- .../XPGSpectrixS40GDetect_Windows.cpp | 19 ++++++++++---- 17 files changed, 200 insertions(+), 142 deletions(-) diff --git a/Controllers/ENESMBusController/ENESMBusController.cpp b/Controllers/ENESMBusController/ENESMBusController.cpp index 04673405..5c5470d5 100644 --- a/Controllers/ENESMBusController/ENESMBusController.cpp +++ b/Controllers/ENESMBusController/ENESMBusController.cpp @@ -1,18 +1,17 @@ -/*-----------------------------------------*\ -| ENESMBusController.cpp | -| | -| Driver for ENE SMBus RGB lighting | -| controller | -| | -| Formerly known as ASUS Aura SMBus. ASUS | -| AURA chips are rebranded ENE controllers | -| | -| Adam Honse (CalcProgrammer1) 8/19/2018 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusController.cpp | +| | +| Driver for ENE SMBus devices | +| | +| Adam Honse (CalcProgrammer1) 19 Aug 2018 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ +#include #include "ENESMBusController.h" #include "LogManager.h" -#include static const char* ene_channels[] = /* ENE channel strings */ { diff --git a/Controllers/ENESMBusController/ENESMBusController.h b/Controllers/ENESMBusController/ENESMBusController.h index 035146fd..97eca646 100644 --- a/Controllers/ENESMBusController/ENESMBusController.h +++ b/Controllers/ENESMBusController/ENESMBusController.h @@ -1,24 +1,24 @@ -/*-----------------------------------------*\ -| ENESMBusController.h | -| | -| Definitions and types for ENE SMBus RGB | -| lighting controller | -| | -| Formerly known as ASUS Aura SMBus. ASUS | -| AURA chips are rebranded ENE controllers | -| | -| Adam Honse (CalcProgrammer1) 8/19/2018 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusController.h | +| | +| Driver for ENE SMBus devices | +| | +| Adam Honse (CalcProgrammer1) 19 Aug 2018 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#pragma once #include #include "ENESMBusInterface.h" #include "RGBController.h" -#pragma once - #define ENE_APPLY_VAL 0x01 /* Value for Apply Changes Register */ #define ENE_SAVE_VAL 0xAA /* Value for Save Changes */ #define ENE_NUM_ZONES 8 /* Number of ENE config table zones */ + enum { ENE_REG_DEVICE_NAME = 0x1000, /* Device String 16 bytes */ diff --git a/Controllers/ENESMBusController/ENESMBusControllerDetect.cpp b/Controllers/ENESMBusController/ENESMBusControllerDetect.cpp index b41753af..9a4e7720 100644 --- a/Controllers/ENESMBusController/ENESMBusControllerDetect.cpp +++ b/Controllers/ENESMBusController/ENESMBusControllerDetect.cpp @@ -1,3 +1,15 @@ +/*---------------------------------------------------------*\ +| ENESMBusControllerDetect.cpp | +| | +| Detector for ENE SMBus devices | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#include +#include +#include #include "Detector.h" #include "ENESMBusController.h" #include "ENESMBusInterface_i2c_smbus.h" @@ -6,9 +18,6 @@ #include "RGBController_ENESMBus.h" #include "i2c_smbus.h" #include "pci_ids.h" -#include -#include -#include #include "dmiinfo.h" #define DETECTOR_NAME "ENE (ASUS Aura) SMBus Controller" diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface.h b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface.h index c5b7193f..be1371aa 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface.h +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface.h @@ -1,15 +1,18 @@ -/*-----------------------------------------*\ -| ENESMBusInterface.h | -| | -| Definitions and types for ENE interface | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ - -#include +/*---------------------------------------------------------*\ +| ENESMBusInterface.h | +| | +| ENE SMBus interface | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once +#include + typedef unsigned short ene_register; typedef unsigned char ene_dev_id; typedef unsigned int ene_interface_type; diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.cpp b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.cpp index 4ddecb7f..b06a109f 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.cpp +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.cpp @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_ROGArion.cpp | -| | -| Code for ENE ASUS ROG Arion interface | -| | -| Adam Honse (CalcProgrammer1) 9/17/2023 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusInterface_ROGArion.cpp | +| | +| ENE SMBus interface for ASUS ROG Arion | +| | +| Adam Honse (CalcProgrammer1) 17 Sep 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "ENESMBusInterface_ROGArion.h" diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.h b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.h index 17215b1e..95aef59e 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.h +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_ROGArion.h @@ -1,11 +1,13 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_ROGArion.h | -| | -| Definitions and types for ENE ASUS ROG | -| Arion interface | -| | -| Adam Honse (CalcProgrammer1) 9/17/2023 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusInterface_ROGArion.h | +| | +| ENE SMBus interface for ASUS ROG Arion | +| | +| Adam Honse (CalcProgrammer1) 17 Sep 2023 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.cpp b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.cpp index 617b69d7..fcd4e306 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.cpp +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.cpp @@ -1,16 +1,18 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_SpectrixS40G.cpp | -| | -| Code for ENE XPG Spectrix S40G NVMe | -| interface | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusInterface_SpectrixS40G_Linux.cpp | +| | +| ENE SMBus interface for XPG Spectrix S40G (Linux) | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ -#include "ENESMBusInterface_SpectrixS40G_Linux.h" -#include -#include #include +#include +#include +#include "ENESMBusInterface_SpectrixS40G_Linux.h" /*---------------------------------------------------------------------*\ | Functions for submitting NVME admin passthrough command taken from | diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.h b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.h index a82d3f32..45d9057d 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.h +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Linux.h @@ -1,16 +1,18 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_SpectrixS40G.h | -| | -| Definitions and types for ENE XPG | -| Spectrix S40G NVMe interface | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ - -#include "ENESMBusInterface.h" +/*---------------------------------------------------------*\ +| ENESMBusInterface_SpectrixS40G_Linux.h | +| | +| ENE SMBus interface for XPG Spectrix S40G (Linux) | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once +#include "ENESMBusInterface.h" + class ENESMBusInterface_SpectrixS40G : public ENESMBusInterface { public: diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.cpp b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.cpp index 05718173..25eb440a 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.cpp +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.cpp @@ -1,18 +1,19 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_SpectrixS40G_Windows | -| | -| Code for ENE XPG Spectrix S40G NVMe | -| interface | -| Windows implementation | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ - -#include "ENESMBusInterface_SpectrixS40G_Windows.h" +/*---------------------------------------------------------*\ +| ENESMBusInterface_SpectrixS40G_Windows.cpp | +| | +| ENE SMBus interface for XPG Spectrix S40G (Windows) | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include -#include #include +#include + +#include "ENESMBusInterface_SpectrixS40G_Windows.h" ENESMBusInterface_SpectrixS40G::ENESMBusInterface_SpectrixS40G(HANDLE fd, wchar_t* path) { diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.h b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.h index 4290686b..ad530c6a 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.h +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_SpectrixS40G_Windows.h @@ -1,18 +1,19 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_SpectrixS40G_Windows.h | -| | -| Definitions and types for ENE XPG | -| Spectrix S40G NVMe interface | -| Windows implementation | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ - -#include "ENESMBusInterface.h" -#include +/*---------------------------------------------------------*\ +| ENESMBusInterface_SpectrixS40G_Windows.h | +| | +| ENE SMBus interface for XPG Spectrix S40G (Windows) | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once +#include +#include "ENESMBusInterface.h" + class ENESMBusInterface_SpectrixS40G : public ENESMBusInterface { public: diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.cpp b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.cpp index aee3eb5f..b15403aa 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.cpp +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.cpp @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_i2c_smbus.cpp | -| | -| Code for ENE I2C/SMBus interface | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusInterface_i2c_smbus.cpp | +| | +| ENE SMBus interface for I2C/SMBus | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "ENESMBusInterface_i2c_smbus.h" diff --git a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.h b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.h index 94dc72a7..8680fa5e 100644 --- a/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.h +++ b/Controllers/ENESMBusController/ENESMBusInterface/ENESMBusInterface_i2c_smbus.h @@ -1,17 +1,19 @@ -/*-----------------------------------------*\ -| ENESMBusInterface_i2c_smbus.h | -| | -| Definitions and types for ENE I2C/SMBus | -| interface | -| | -| Adam Honse (CalcProgrammer1) 11/21/2021 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| ENESMBusInterface_i2c_smbus.h | +| | +| ENE SMBus interface for I2C/SMBus | +| | +| Adam Honse (CalcProgrammer1) 21 Nov 2021 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#pragma once #include "ENESMBusInterface.h" #include "i2c_smbus.h" -#pragma once - class ENESMBusInterface_i2c_smbus : public ENESMBusInterface { public: diff --git a/Controllers/ENESMBusController/RGBController_ENESMBus.cpp b/Controllers/ENESMBusController/RGBController_ENESMBus.cpp index 54f789df..7e5ac5f5 100644 --- a/Controllers/ENESMBusController/RGBController_ENESMBus.cpp +++ b/Controllers/ENESMBusController/RGBController_ENESMBus.cpp @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_ENESMBus.cpp | -| | -| Generic RGB Interface for ENE SMBus | -| | -| Adam Honse (CalcProgrammer1) 6/13/2019 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_ENESMBus.cpp | +| | +| RGBController for ENE SMBus devices | +| | +| Adam Honse (CalcProgrammer1) 13 Jun 2019 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #include "RGBController_ENESMBus.h" #include "LogManager.h" diff --git a/Controllers/ENESMBusController/RGBController_ENESMBus.h b/Controllers/ENESMBusController/RGBController_ENESMBus.h index 80ac9647..702ec903 100644 --- a/Controllers/ENESMBusController/RGBController_ENESMBus.h +++ b/Controllers/ENESMBusController/RGBController_ENESMBus.h @@ -1,10 +1,13 @@ -/*-----------------------------------------*\ -| RGBController_ENESMBus.h | -| | -| Generic RGB Interface for ENE SMBus | -| | -| Adam Honse (CalcProgrammer1) 6/13/2019 | -\*-----------------------------------------*/ +/*---------------------------------------------------------*\ +| RGBController_ENESMBus.h | +| | +| RGBController for ENE SMBus devices | +| | +| Adam Honse (CalcProgrammer1) 13 Jun 2019 | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ #pragma once diff --git a/Controllers/ENESMBusController/ROGArionDetect.cpp b/Controllers/ENESMBusController/ROGArionDetect.cpp index c2ee3172..2c2f3c7e 100644 --- a/Controllers/ENESMBusController/ROGArionDetect.cpp +++ b/Controllers/ENESMBusController/ROGArionDetect.cpp @@ -1,11 +1,19 @@ +/*---------------------------------------------------------*\ +| ROGArionDetect.cpp | +| | +| Detector for ASUS ROG Arion | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#include #include "Detector.h" #include "ENESMBusController.h" #include "ENESMBusInterface_ROGArion.h" #include "LogManager.h" #include "RGBController.h" #include "RGBController_ENESMBus.h" -#include - #include "scsiapi.h" /******************************************************************************************\ diff --git a/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Linux.cpp b/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Linux.cpp index 95711582..8e2dbd18 100644 --- a/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Linux.cpp +++ b/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Linux.cpp @@ -1,16 +1,24 @@ +/*---------------------------------------------------------*\ +| XPGSpectrixS40GDetect_Linux.cpp | +| | +| Detector for XPG Spectrix S40G (Linux) | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#include +#include +#include +#include +#include +#include #include "Detector.h" #include "ENESMBusController.h" #include "ENESMBusInterface_SpectrixS40G_Linux.h" #include "LogManager.h" #include "RGBController.h" #include "RGBController_ENESMBus.h" -#include -#include -#include - -#include -#include -#include /******************************************************************************************\ * * diff --git a/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Windows.cpp b/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Windows.cpp index bfcd5cff..b8268180 100644 --- a/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Windows.cpp +++ b/Controllers/ENESMBusController/XPGSpectrixS40GDetect_Windows.cpp @@ -1,16 +1,25 @@ +/*---------------------------------------------------------*\ +| XPGSpectrixS40GDetect_Windows.cpp | +| | +| Detector for XPG Spectrix S40G (Windows) | +| | +| This file is part of the OpenRGB project | +| SPDX-License-Identifier: GPL-2.0-only | +\*---------------------------------------------------------*/ + +#include +#include +#include +#include +#include #include "Detector.h" #include "ENESMBusController.h" #include "ENESMBusInterface_SpectrixS40G_Windows.h" #include "LogManager.h" #include "RGBController.h" #include "RGBController_ENESMBus.h" -#include -#include -#include #define DEVBUFSIZE (128 * 1024) -#include -#include /*----------------------------------------------------------------------*\ | Windows defines "interface" for some reason. Work around this |