Update more file header comments to standardized new format

This commit is contained in:
Adam Honse 2024-05-03 00:36:28 -05:00
parent f38b7485f7
commit b12cd438cd
15 changed files with 175 additions and 141 deletions

View file

@ -1,12 +1,15 @@
/*-----------------------------------------*\
| hidapi_wrapper.h |
| |
| Wrapper for hidapi that can select from |
| default or libusb backends on Linux |
| |
| Matt Silva (thesilvanator) 2022 |
| Adam Honse (calcprogrammer1) 2023 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| hidapi_wrapper.h |
| |
| Wrapper for hidapi that can select from default or |
| libusb backends on Linux |
| |
| Matt Silva (thesilvanator) 2022 |
| Adam Honse (CalcProgrammer1) 2023 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once

View file

@ -1,10 +1,14 @@
/******************************************************************************************\
* *
* i2c_smbus.cpp *
* *
* Device-independent i2c/SMBus communication functions *
* *
\******************************************************************************************/
/*---------------------------------------------------------*\
| i2c_smbus.cpp |
| |
| Device-independent i2c/SMBus communication functions |
| |
| Adam Honse (CalcProgrammer1) 08 Aug 2018 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus.h"
#include <string.h>
@ -246,4 +250,4 @@ void i2c_smbus_interface::i2c_smbus_thread_function()
i2c_smbus_done_cv.notify_all();
done_lock.unlock();
}
}
}

View file

@ -1,12 +1,14 @@
/*-----------------------------------------*\
| i2c_smbus.h |
| |
| Definitions and types for SMBUS drivers |
| |
| Adam Honse (CalcProgrammer1) 8/8/2018 |
| Portions based on Linux source code |
| GNU GPL v2 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus.h |
| |
| Device-independent i2c/SMBus communication functions |
| |
| Adam Honse (CalcProgrammer1) 08 Aug 2018 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#ifndef I2C_SMBUS_H
#define I2C_SMBUS_H

View file

@ -1,11 +1,13 @@
/*-----------------------------------------*\
| i2c_smbus_amdadl.cpp |
| |
| Definitions and types for AMD ADL I2C |
| functions |
| |
| Niels Westphal (crashniels) 05/30/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_amdadl.cpp |
| |
| Definitions and types for AMD ADL I2C functions |
| |
| Niels Westphal (crashniels) 30 May 2020 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus_amdadl.h"
#include "LogManager.h"

View file

@ -1,22 +1,24 @@
/*-----------------------------------------*\
| i2c_smbus_amdadl.h |
| |
| Definitions and types for AMD ADL I2C |
| functions |
| |
| Niels Westphal (crashniels) 05/30/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_amdadl.h |
| |
| Definitions and types for AMD ADL I2C functions |
| |
| Niels Westphal (crashniels) 30 May 2020 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include <tchar.h>
#include <stdio.h>
#include <vector>
#include "i2c_smbus.h"
#include "adl_sdk.h"
#include "adl_defines.h"
#include "adl_structures.h"
#include "windows.h"
#include <tchar.h>
#include <stdio.h>
#include <vector>
#pragma once
class i2c_smbus_amdadl : public i2c_smbus_interface
{

View file

@ -1,12 +1,14 @@
/*-----------------------------------------*\
| i2c_smbus_i801.cpp |
| |
| i801 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 1/29/2019 |
| Portions based on Linux source code |
| GNU GPL v2 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_i801.cpp |
| |
| i801 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 29 Jan 2019 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus_i801.h"
#include "ResourceManager.h"

View file

@ -1,12 +1,16 @@
/*-----------------------------------------*\
| i2c_smbus_i801.h |
| |
| i801 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 1/29/2019 |
| Portions based on Linux source code |
| GNU GPL v2 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_i801.h |
| |
| i801 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 29 Jan 2019 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include "i2c_smbus.h"
@ -14,8 +18,6 @@
#include <Windows.h>
#endif
#pragma once
/* BIT shifting macro */
#define BIT(x) ( 1 << x )

View file

@ -1,20 +1,21 @@
/*-----------------------------------------*\
| i2c_smbus_linux.cpp |
| |
| Linux i2c/smbus driver |
| |
| Adam Honse (CalcProgrammer1) 2/14/2019 |
\*-----------------------------------------*/
#include "LogManager.h"
#include "i2c_smbus.h"
#include "i2c_smbus_linux.h"
/*---------------------------------------------------------*\
| i2c_smbus_linux.cpp |
| |
| Linux i2c/smbus driver |
| |
| Adam Honse (CalcProgrammer1) 14 Feb 2019 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include <linux/i2c-dev.h>
#include <linux/i2c.h>
#include <sys/ioctl.h>
#include <cstring>
#include "LogManager.h"
#include "i2c_smbus.h"
#include "i2c_smbus_linux.h"
s32 i2c_smbus_linux::i2c_smbus_xfer(u8 addr, char read_write, u8 command, int size, union i2c_smbus_data* data)
{

View file

@ -1,11 +1,13 @@
/*-----------------------------------------*\
| i2c_smbus_linux.h |
| |
| Definitions and types for Linux i2c/smbus|
| driver |
| |
| Adam Honse (CalcProgrammer1) 2/14/2019 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_linux.h |
| |
| Linux i2c/smbus driver |
| |
| Adam Honse (CalcProgrammer1) 14 Feb 2019 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus.h"

View file

@ -1,10 +1,13 @@
/*-----------------------------------------*\
| i2c_smbus_nct6775.cpp |
| |
| Nuvoton NCT67xx SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 5/19/2019 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_nct6775.cpp |
| |
| Nuvoton NCT67xx SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 19 May 2019 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus_nct6775.h"
#include "OlsApi.h"

View file

@ -1,16 +1,19 @@
/*-----------------------------------------*\
| i2c_smbus_nct6775.h |
| |
| Nuvoton NCT67xx SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 5/19/2019 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_nct6775.h |
| |
| Nuvoton NCT67xx SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 19 May 2019 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include "i2c_smbus.h"
#include <Windows.h>
#pragma once
#define SMBHSTDAT (0 + nct6775_smba)
#define SMBBLKSZ (1 + nct6775_smba)
#define SMBHSTCMD (2 + nct6775_smba)

View file

@ -1,10 +1,13 @@
/*-----------------------------------------*\
| i2c_smbus_nvapi.cpp |
| |
| NVidia NvAPI I2C driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 2/21/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_nvapi.cpp |
| |
| NVidia NvAPI I2C driver |
| |
| Adam Honse (CalcProgrammer1) 21 Feb 2020 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus_nvapi.h"

View file

@ -1,17 +1,19 @@
/*-----------------------------------------*\
| i2c_smbus_nvapi.h |
| |
| Definitions and types for NVidia NvAPI |
| I2C driver |
| |
| Adam Honse (CalcProgrammer1) 2/21/2020 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_nvapi.h |
| |
| NVidia NvAPI I2C driver |
| |
| Adam Honse (CalcProgrammer1) 21 Feb 2020 |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include "i2c_smbus.h"
#include "nvapi.h"
#pragma once
class i2c_smbus_nvapi : public i2c_smbus_interface
{
public:

View file

@ -1,12 +1,14 @@
/*-----------------------------------------*\
| i2c_smbus_piix4.cpp |
| |
| PIIX4 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 8/8/2018 |
| Portions based on Linux source code |
| GNU GPL v2 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_piix4.cpp |
| |
| PIIX4 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 08 Aug 2018 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#include "i2c_smbus_piix4.h"
#include "OlsApi.h"

View file

@ -1,19 +1,20 @@
/*-----------------------------------------*\
| i2c_smbus_piix4.h |
| |
| Definitions and types for PIIX4 SMBUS |
| driver |
| |
| Adam Honse (CalcProgrammer1) 8/8/2018 |
| Portions based on Linux source code |
| GNU GPL v2 |
\*-----------------------------------------*/
/*---------------------------------------------------------*\
| i2c_smbus_piix4.h |
| |
| PIIX4 SMBUS driver for Windows |
| |
| Adam Honse (CalcProgrammer1) 08 Aug 2018 |
| Portions based on Linux source code |
| |
| This file is part of the OpenRGB project |
| SPDX-License-Identifier: GPL-2.0-only |
\*---------------------------------------------------------*/
#pragma once
#include "i2c_smbus.h"
#include "windows.h"
#pragma once
// PIIX4 SMBus address offsets
#define SMBHSTSTS (0 + piix4_smba)
#define SMBHSLVSTS (1 + piix4_smba)