Proto.h

/*
 * This file is part of OpenCorsairLink.
 * Copyright (C) 2014  Sean Nelson <audiohacked@gmail.com>

 * OpenCorsairLink is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * any later version.

 * OpenCorsairLink is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with OpenCorsairLink.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _CORSAIRLINKPROTO_H
#define _CORSAIRLINKPROTO_H
/*
 * http://forum.corsair.com/v3/showthread.php?t=120092&page=3
 * */
enum CorsairLinkCommands {
	/*
	 * R - 1 byte 
	 * (H80 0x37, Cooling node 0x38, Lighting node 0x39, H100 0x3A, 80i 0x3B, 100i 0x3c -- 
	 * this field as well as the version are common on all C-Link devices; but the rest aren't
	 * */
	DeviceID = 0x00, 


	/*
	 * R - 2 bytes
	 * Firmware Version in BCD (for example 1.0.5 is 0x1005, or 0x05, 0x10 in little endianess)
	 * */
	FirmwareID = 0x01,


	/*
	 * R - 8 bytes
	 * Product name, zero-terminated - only present on the H80i and H100i
	 * */
	ProductName = 0x02,


	/*
	 * R - 1 byte
	 * Status, 0 okay, 0xFF bad
	 * */
	Status = 0x03,


	/*
	 * RW - 1 byte
	 * Select current LED
	 * */
	LED_SelectCurrent = 0x04,


	/*
	 * R - 1 byte	 
	 * Number of LEDs
	 * */
	LED_Count = 0x05,


	/*
	 * RW - 1 byte
	 * LED mode - 0x00 for static color, 0x40 for 2-color cycle, 0x80 for 4-color, 0xC0 for temperature mode; 
	 * low nibble defines cycle speed or the temperature channel to use (0 internal sensor, 7 manual)
	 * */
	LED_Mode = 0x06,


	/*
	 * R - 3 bytes
	 * LED current color, RGB color of the selected LED
	 * */
	LED_CurrentColor = 0x07,


	/*
	 * RW - 2 bytes
	 * In temperature controlled mode (0xC0) this defines the colour to use to with the below gradients
	 * */
	LED_TemperatureColor = 0x08,


	/*
	 * RW - 6 bytes
	 * LED temperature-mode temperatures: 3 temperatures; used when cycle mode is 0xc0
	 * */
	LED_TemperatureMode = 0x09,


	/*
	 * RW - 9 bytes
	 * LED temperature-mode colors: RGBx3 colors, corresponding to temperatures in register above
	 * */
	LED_TemperatureModeColors = 0x0A,


	/*
	 * RW - 12 bytes
	 * LED cycle colors: RGBx4 colors (only first color used if cycle mode set to 00, first two if 4b, ignored if c0)
	 * */
	LED_CycleColors = 0x0B,


	/*
	 * RW - 1 byte
	 * Select active temperature sensor
	 * */
	TEMP_SelectActiveSensor = 0x0C,


	/*
	 * R - 1 byte
	 * Number of temperature sensors
	 * */
	TEMP_CountSensors = 0x0D,


	/*
	 * R - 2 bytes
	 * Temperature as measured by selected sensor
	 * */
	TEMP_Read = 0x0E,


	/*
	 * RW - 2 bytes
	 * Temperature limit (when the temperature goes over this, status is set to 0xff)
	 * */
	TEMP_Limit = 0x0F,


	/*
	 * RW - 1 byte
	 * Select current fan; for H100i, 0-3 are the fans, 4 is pump
	 * */
	FAN_Select = 0x10,


	/*
	 * R - 1 byte
	 * Number of fans
	 * */
	FAN_Count = 0x11,


	/*
	 * RW - 1 byte
	 * Fan mode; 02=fixed PWM, 04=fixed RPM, 06=default, 08=quiet, 0a=balanced, 0c=performance, 0e=custom; high bit is one when fan is detected, 
	 * low bit is one when the fan is 4-pin, bits 6~4 define the temperautre channel to use in "curve" modes, 0 internal and 7 manual
	 * */
	FAN_Mode = 0x12,


	/*
	 * RW - 1 byte
	 * Fan fixed PWM, 0-255, only used if fan mode is 02
	 * */
	FAN_FixedPWM = 0x13,


	/*
	 * RW - 2 bytes
	 * Fan fixed RPM; when fan mode is 04, controller will target this RPM
	 * */
	FAN_FixedRPM = 0x14,


	/*
	 * RW - 2 bytes
	 * Report external temperature to fan controller - used for controlling fans via external sensors
	 * */
	FAN_ReportExtTemp = 0x15,


	/*
	 * R - 2 bytes
	 * Current fan RPM
	 * */
	FAN_ReadRPM = 0x16,


	/*
	 * R - 2 bytes
	 * Maximum RPM recorded since power-on
	 * */
	FAN_MaxRecordedRPM = 0x17,


	/*
	 * RW - 2 bytes
	 * Fan under speed threshold
	 * */
	FAN_UnderSpeedThreshold = 0x18,


	/*
	 * RW - 10 bytes
	 * Fan RPM table, for custom (0e) mode: array of 5 RPMs
	 * */
	FAN_RPMTable = 0x19,


	/*
	 * RW - 10 bytes
	 * Fan temp table, for custom (0e) mode: array of 5 temperatures
	 * */
	FAN_TempTable = 0x1A
};

/*
 * http://forum.corsair.com/v3/showthread.php?t=120092
 * */
enum _CorsairLinkOpCodes{
	/*
	 * 06 AA BB - Write BB into one-byte register AA
	 * */
	WriteOneByte = 0x06,
	/*
	 * 07 AA - Read from one-byte register AA
	 * */
	ReadOneByte = 0x07,
	/*
	 * 08 AA BB CC - Write BB CC into two-byte register AA
	 * */
	WriteTwoBytes = 0x08,
	/*
	 * 09 AA - Read from two-byte register AA
	 * */
	ReadTwoBytes = 0x09,
	/*
	 * 0A AA 03 00 11 22 - Write 3-byte sequence (00 11 22) into 3-byte register AA
	 * */
	WriteThreeBytes = 0x0A,
	/*
	 * 0B AA 03 - Read from 3-byte register AA
	 * */
	ReadThreeBytes = 0x0B,
};

enum CorsairLedModes {
	StaticColor = 0x00,
	TwoColorCycle = 0x40,
	FourColorCycle = 0x80,
	TemperatureColor = 0xC0
};

enum CorsairFanModes {
	FixedPWM = 0x02,
	FixedRPM = 0x04,
	Default = 0x06,
	Quiet = 0x08,
	Balanced = 0x0A,
	Performance = 0x0C,
	Custom = 0x0E
};

//extern CorsairLink *cl;
#endif