Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit cb7cf3da authored by Stefan Achatz's avatar Stefan Achatz Committed by Jiri Kosina
Browse files

HID: roccat: add driver for Roccat Pyra mouse 

This patch add support for Pyra mobile gaming mouse from Roccat.
It provides access to profiles, settings, actual settings etc.
through sysfs attributes.
This driver is conceptual similar to the existing Kone driver.
Userland tools can soon be found at http://sourceforge.net/projects/roccat



Signed-off-by: default avatarStefan Achatz <erazor_de@users.sourceforge.net>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
parent 763008c4

Documentation/ABI/testing/sysfs-driver-hid-roccat-pyra

0 → 100644
+98 −0
Original line number Original line Diff line number Diff line 
What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/actual_cpi

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	It is possible to switch the cpi setting of the mouse with the

		press of a button.

		When read, this file returns the raw number of the actual cpi

		setting reported by the mouse. This number has to be further

		processed to receive the real dpi value.



		VALUE DPI

		1     400

		2     800

		4     1600



		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/actual_profile

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	When read, this file returns the number of the actual profile in

		range 0-4.

		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/firmware_version

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	When read, this file returns the raw integer version number of the

		firmware reported by the mouse. Using the integer value eases

		further usage in other programs. To receive the real version

		number the decimal point has to be shifted 2 positions to the

		left. E.g. a returned value of 138 means 1.38

		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile_settings

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	The mouse can store 5 profiles which can be switched by the

		press of a button. A profile is split in settings and buttons.

		profile_settings holds informations like resolution, sensitivity

		and light effects.

		When written, this file lets one write the respective profile

		settings back to the mouse. The data has to be 13 bytes long.

		The mouse will reject invalid data.

		Which profile to write is determined by the profile number

		contained in the data.

		This file is writeonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile[1-5]_settings

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	The mouse can store 5 profiles which can be switched by the

		press of a button. A profile is split in settings and buttons.

		profile_settings holds informations like resolution, sensitivity

		and light effects.

		When read, these files return the respective profile settings.

		The returned data is 13 bytes in size.

		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile_buttons

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	The mouse can store 5 profiles which can be switched by the

		press of a button. A profile is split in settings and buttons.

		profile_buttons holds informations about button layout.

		When written, this file lets one write the respective profile

		buttons back to the mouse. The data has to be 19 bytes long.

		The mouse will reject invalid data.

		Which profile to write is determined by the profile number

		contained in the data.

		This file is writeonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/profile[1-5]_buttons

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	The mouse can store 5 profiles which can be switched by the

		press of a button. A profile is split in settings and buttons.

		profile_buttons holds informations about button layout.

		When read, these files return the respective profile buttons.

		The returned data is 19 bytes in size.

		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/startup_profile

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	The integer value of this attribute ranges from 0-4.

                When read, this attribute returns the number of the profile

                that's active when the mouse is powered on.

		This file is readonly.



What:		/sys/bus/usb/devices/<busnum>-<devnum>:<config num>.<interface num>/settings

Date:		August 2010

Contact:	Stefan Achatz <erazor_de@users.sourceforge.net>

Description:	When read, this file returns the settings stored in the mouse.

		The size of the data is 3 bytes and holds information on the

		startup_profile.

		When written, this file lets write settings back to the mouse.

		The data has to be 3 bytes long. The mouse will reject invalid

		data.

drivers/hid/Kconfig

+7 −0
Original line number Original line Diff line number Diff line
@@ -376,6 +376,13 @@ config HID_ROCCAT_KONE 
	---help---

	---help---

	Support for Roccat Kone mouse.

	Support for Roccat Kone mouse.





config HID_ROCCAT_PYRA

	tristate "Roccat Pyra mouse support"

	depends on USB_HID

	select HID_ROCCAT

	---help---

	Support for Roccat Pyra mouse.



config HID_SAMSUNG

config HID_SAMSUNG

	tristate "Samsung"

	tristate "Samsung"

	depends on USB_HID

	depends on USB_HID

drivers/hid/Makefile

+1 −0
Original line number Original line Diff line number Diff line
@@ -52,6 +52,7 @@ obj-$(CONFIG_HID_PETALYNX) += hid-petalynx.o 
obj-$(CONFIG_HID_PICOLCD)	+= hid-picolcd.o

obj-$(CONFIG_HID_PICOLCD)	+= hid-picolcd.o

obj-$(CONFIG_HID_ROCCAT)	+= hid-roccat.o

obj-$(CONFIG_HID_ROCCAT)	+= hid-roccat.o

obj-$(CONFIG_HID_ROCCAT_KONE)	+= hid-roccat-kone.o

obj-$(CONFIG_HID_ROCCAT_KONE)	+= hid-roccat-kone.o

obj-$(CONFIG_HID_ROCCAT_PYRA)	+= hid-roccat-pyra.o

obj-$(CONFIG_HID_SAMSUNG)	+= hid-samsung.o

obj-$(CONFIG_HID_SAMSUNG)	+= hid-samsung.o

obj-$(CONFIG_HID_SMARTJOYPLUS)	+= hid-sjoy.o

obj-$(CONFIG_HID_SMARTJOYPLUS)	+= hid-sjoy.o

obj-$(CONFIG_HID_SONY)		+= hid-sony.o

obj-$(CONFIG_HID_SONY)		+= hid-sony.o

drivers/hid/hid-core.c

+1 −0
Original line number Original line Diff line number Diff line
@@ -1367,6 +1367,7 @@ static const struct hid_device_id hid_blacklist[] = { 
	{ HID_USB_DEVICE(USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_QUANTA_OPTICAL_TOUCH) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_QUANTA, USB_DEVICE_ID_PIXART_IMAGING_INC_OPTICAL_TOUCH_SCREEN) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_KONE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_ROCCAT, USB_DEVICE_ID_ROCCAT_PYRA_WIRED) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_IR_REMOTE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SAMSUNG, USB_DEVICE_ID_SAMSUNG_WIRELESS_KBD_MOUSE) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER) },

	{ HID_USB_DEVICE(USB_VENDOR_ID_SONY, USB_DEVICE_ID_SONY_PS3_CONTROLLER) },

drivers/hid/hid-ids.h

+2 −0
Original line number Original line Diff line number Diff line
@@ -459,6 +459,8 @@ 




#define USB_VENDOR_ID_ROCCAT		0x1e7d

#define USB_VENDOR_ID_ROCCAT		0x1e7d

#define USB_DEVICE_ID_ROCCAT_KONE	0x2ced

#define USB_DEVICE_ID_ROCCAT_KONE	0x2ced

#define USB_DEVICE_ID_ROCCAT_PYRA_WIRED	0x2c24

#define USB_DEVICE_ID_ROCCAT_PYRA_WIRELESS	0x2cf6





#define USB_VENDOR_ID_SAITEK		0x06a3

#define USB_VENDOR_ID_SAITEK		0x06a3

#define USB_DEVICE_ID_SAITEK_RUMBLEPAD	0xff17

#define USB_DEVICE_ID_SAITEK_RUMBLEPAD	0xff17