Commit 949aaccd authored by Roderick Colenbrander's avatar Roderick Colenbrander Committed by Benjamin Tissoires
Browse files

HID: playstation: add DualSense player LED support. 



The DualSense features 5 player LEDs below its touchpad, which are
meant as player id indications. The LEDs are configured with a
player ID determined by an ID allocator, which assign player ids
to ps_device instances.

This patch is a combination of the following original patches
minus use of LED framework APIs:
- HID: playstation: add DualSense player LEDs support.
- HID: playstation: DualSense set LEDs to default player id.

Signed-off-by: default avatarRoderick Colenbrander <roderick.colenbrander@sony.com>
Reviewed-by: default avatarBarnabás Pőcze <pobrn@protonmail.com>
Signed-off-by: default avatarBenjamin Tissoires <benjamin.tissoires@redhat.com>
parent c26e48b1

drivers/hid/hid-playstation.c

+82 −1
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ 
#include <linux/crc32.h>

#include <linux/device.h>

#include <linux/hid.h>

#include <linux/idr.h>

#include <linux/input/mt.h>

#include <linux/module.h>
@@ -20,6 +21,8 @@ 
static DEFINE_MUTEX(ps_devices_lock);

static LIST_HEAD(ps_devices_list);



static DEFINE_IDA(ps_player_id_allocator);



#define HID_PLAYSTATION_VERSION_PATCH 0x8000



/* Base class for playstation devices. */
@@ -28,6 +31,8 @@ struct ps_device { 
	struct hid_device *hdev;

	spinlock_t lock;



	uint32_t player_id;



	struct power_supply_desc battery_desc;

	struct power_supply *battery;

	uint8_t battery_capacity;
@@ -108,6 +113,7 @@ struct ps_calibration_data { 
#define DS_OUTPUT_VALID_FLAG1_POWER_SAVE_CONTROL_ENABLE BIT(1)

#define DS_OUTPUT_VALID_FLAG1_LIGHTBAR_CONTROL_ENABLE BIT(2)

#define DS_OUTPUT_VALID_FLAG1_RELEASE_LEDS BIT(3)

#define DS_OUTPUT_VALID_FLAG1_PLAYER_INDICATOR_CONTROL_ENABLE BIT(4)

#define DS_OUTPUT_VALID_FLAG2_LIGHTBAR_SETUP_CONTROL_ENABLE BIT(1)

#define DS_OUTPUT_POWER_SAVE_CONTROL_MIC_MUTE BIT(4)

#define DS_OUTPUT_LIGHTBAR_SETUP_LIGHT_OUT BIT(1)
@@ -151,6 +157,11 @@ struct dualsense { 
	bool mic_muted;

	bool last_btn_mic_state;



	/* Player leds */

	bool update_player_leds;

	uint8_t player_leds_state;

	struct led_classdev player_leds[5];



	struct work_struct output_worker;

	void *output_report_dmabuf;

	uint8_t output_seq; /* Sequence number for output report. */
@@ -309,6 +320,24 @@ static int ps_devices_list_remove(struct ps_device *dev) 
	return 0;

}



static int ps_device_set_player_id(struct ps_device *dev)

{

	int ret = ida_alloc(&ps_player_id_allocator, GFP_KERNEL);



	if (ret < 0)

		return ret;



	dev->player_id = ret;

	return 0;

}



static void ps_device_release_player_id(struct ps_device *dev)

{

	ida_free(&ps_player_id_allocator, dev->player_id);



	dev->player_id = U32_MAX;

}



static struct input_dev *ps_allocate_input_dev(struct hid_device *hdev, const char *name_suffix)

{

	struct input_dev *input_dev;
@@ -824,6 +853,13 @@ static void dualsense_output_worker(struct work_struct *work) 
		ds->update_lightbar = false;

	}



	if (ds->update_player_leds) {

		common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_PLAYER_INDICATOR_CONTROL_ENABLE;

		common->player_leds = ds->player_leds_state;



		ds->update_player_leds = false;

	}



	if (ds->update_mic_mute) {

		common->valid_flag1 |= DS_OUTPUT_VALID_FLAG1_MIC_MUTE_LED_CONTROL_ENABLE;

		common->mute_button_led = ds->mic_muted;
@@ -1078,6 +1114,29 @@ static void dualsense_set_lightbar(struct dualsense *ds, uint8_t red, uint8_t gr 
	schedule_work(&ds->output_worker);

}



static void dualsense_set_player_leds(struct dualsense *ds)

{

	/*

	 * The DualSense controller has a row of 5 LEDs used for player ids.

	 * Behavior on the PlayStation 5 console is to center the player id

	 * across the LEDs, so e.g. player 1 would be "--x--" with x being 'on'.

	 * Follow a similar mapping here.

	 */

	static const int player_ids[5] = {

		BIT(2),

		BIT(3) | BIT(1),

		BIT(4) | BIT(2) | BIT(0),

		BIT(4) | BIT(3) | BIT(1) | BIT(0),

		BIT(4) | BIT(3) | BIT(2) | BIT(1) | BIT(0)

	};



	uint8_t player_id = ds->base.player_id % ARRAY_SIZE(player_ids);



	ds->update_player_leds = true;

	ds->player_leds_state = player_ids[player_id];

	schedule_work(&ds->output_worker);

}



static struct ps_device *dualsense_create(struct hid_device *hdev)

{

	struct dualsense *ds;
@@ -1166,6 +1225,15 @@ static struct ps_device *dualsense_create(struct hid_device *hdev) 


	dualsense_set_lightbar(ds, 0, 0, 128); /* blue */



	ret = ps_device_set_player_id(ps_dev);

	if (ret) {

		hid_err(hdev, "Failed to assign player id for DualSense: %d\n", ret);

		goto err;

	}



	/* Set player LEDs to our player id. */

	dualsense_set_player_leds(ds);



	/*

	 * Reporting hardware and firmware is important as there are frequent updates, which

	 * can change behavior.
@@ -1243,6 +1311,7 @@ static void ps_remove(struct hid_device *hdev) 
	struct ps_device *dev = hid_get_drvdata(hdev);



	ps_devices_list_remove(dev);

	ps_device_release_player_id(dev);



	hid_hw_close(hdev);

	hid_hw_stop(hdev);
@@ -1263,7 +1332,19 @@ static struct hid_driver ps_driver = { 
	.raw_event	= ps_raw_event,

};



module_hid_driver(ps_driver);

static int __init ps_init(void)

{

	return hid_register_driver(&ps_driver);

}



static void __exit ps_exit(void)

{

	hid_unregister_driver(&ps_driver);

	ida_destroy(&ps_player_id_allocator);

}



module_init(ps_init);

module_exit(ps_exit);



MODULE_AUTHOR("Sony Interactive Entertainment");

MODULE_DESCRIPTION("HID Driver for PlayStation peripherals.");