Unverified Commit 13ef21df authored by Shuming Fan's avatar Shuming Fan Committed by Mark Brown
Browse files

ASoC: SDCA: add support for HIDE entity properties and HID descriptor/report 



Add support for parsing the HIDE entity descriptor and HID descriptor/report

Signed-off-by: default avatarShuming Fan <shumingf@realtek.com>
Reviewed-by: default avatarCharles Keepax <ckeepax@opensource.cirrus.com>
Link: https://patch.msgid.link/20250616114820.855401-1-shumingf@realtek.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent f186a1a9

include/sound/sdca_function.h

+29 −0
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ 


#include <linux/bits.h>

#include <linux/types.h>

#include <linux/hid.h>



struct device;

struct sdca_entity;
@@ -1040,6 +1041,32 @@ struct sdca_entity_ge { 
	int num_modes;

};



/**

 * struct sdca_entity_hide - information specific to HIDE Entities

 * @hid: HID device structure

 * @hidtx_ids: HIDTx Report ID

 * @num_hidtx_ids: number of HIDTx Report ID

 * @hidrx_ids: HIDRx Report ID

 * @num_hidrx_ids: number of HIDRx Report ID

 * @hide_reside_function_num: indicating which Audio Function Numbers within this Device

 * @max_delay: the maximum time in microseconds allowed for the Device to change the ownership from Device to Host

 * @af_number_list: which Audio Function Numbers within this Device are sending/receiving the messages in this HIDE

 * @hid_desc: HID descriptor for the HIDE Entity

 * @hid_report_desc: HID Report Descriptor for the HIDE Entity

 */

struct sdca_entity_hide {

	struct hid_device *hid;

	unsigned int *hidtx_ids;

	int num_hidtx_ids;

	unsigned int *hidrx_ids;

	int num_hidrx_ids;

	unsigned int hide_reside_function_num;

	unsigned int max_delay;

	unsigned int af_number_list[SDCA_MAX_FUNCTION_COUNT];

	struct hid_descriptor hid_desc;

	unsigned char *hid_report_desc;

};



/**

 * struct sdca_entity - information for one SDCA Entity

 * @label: String such as "OT 12".
@@ -1055,6 +1082,7 @@ struct sdca_entity_ge { 
 * @cs: Clock Source specific Entity properties.

 * @pde: Power Domain Entity specific Entity properties.

 * @ge: Group Entity specific Entity properties.

 * @hide: HIDE Entity specific Entity properties.

 */

struct sdca_entity {

	const char *label;
@@ -1071,6 +1099,7 @@ struct sdca_entity { 
		struct sdca_entity_cs cs;

		struct sdca_entity_pde pde;

		struct sdca_entity_ge ge;

		struct sdca_entity_hide hide;

	};

};

sound/soc/sdca/sdca_functions.c

+83 −0
Original line number Diff line number Diff line
@@ -1220,6 +1220,86 @@ static int find_sdca_entity_ge(struct device *dev, 
	return -EINVAL;

}



static int

find_sdca_entity_hide(struct device *dev, struct fwnode_handle *function_node,

		      struct fwnode_handle *entity_node, struct sdca_entity *entity)

{

	struct sdca_entity_hide *hide = &entity->hide;

	unsigned int delay, *af_list = hide->af_number_list;

	int nval, ret;

	unsigned char *report_desc = NULL;



	ret = fwnode_property_read_u32(entity_node,

				       "mipi-sdca-RxUMP-ownership-transition-maxdelay", &delay);

	if (!ret)

		hide->max_delay = delay;



	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-HIDTx-supported-report-ids");

	if (nval > 0) {

		hide->num_hidtx_ids = nval;

		hide->hidtx_ids = devm_kcalloc(dev, hide->num_hidtx_ids,

					       sizeof(*hide->hidtx_ids), GFP_KERNEL);

		if (!hide->hidtx_ids)

			return -ENOMEM;



		ret = fwnode_property_read_u32_array(entity_node,

						     "mipi-sdca-HIDTx-supported-report-ids",

						     hide->hidtx_ids,

						     hide->num_hidtx_ids);

		if (ret < 0)

			return ret;

	}



	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-HIDRx-supported-report-ids");

	if (nval > 0) {

		hide->num_hidrx_ids = nval;

		hide->hidrx_ids = devm_kcalloc(dev, hide->num_hidrx_ids,

					       sizeof(*hide->hidrx_ids), GFP_KERNEL);

		if (!hide->hidrx_ids)

			return -ENOMEM;



		ret = fwnode_property_read_u32_array(entity_node,

						     "mipi-sdca-HIDRx-supported-report-ids",

						     hide->hidrx_ids,

						     hide->num_hidrx_ids);

		if (ret < 0)

			return ret;

	}



	nval = fwnode_property_count_u32(entity_node, "mipi-sdca-hide-related-audio-function-list");

	if (nval <= 0) {

		dev_err(dev, "%pfwP: audio function numbers list missing: %d\n",

			entity_node, nval);

		return -EINVAL;

	} else if (nval > SDCA_MAX_FUNCTION_COUNT) {

		dev_err(dev, "%pfwP: maximum number of audio function exceeded\n", entity_node);

		return -EINVAL;

	}



	hide->hide_reside_function_num = nval;

	fwnode_property_read_u32_array(entity_node,

				       "mipi-sdca-hide-related-audio-function-list", af_list, nval);



	nval = fwnode_property_count_u8(function_node, "mipi-sdca-hid-descriptor");

	if (nval)

		fwnode_property_read_u8_array(function_node, "mipi-sdca-hid-descriptor",

					      (u8 *)&hide->hid_desc, nval);



	if (hide->hid_desc.bNumDescriptors) {

		nval = fwnode_property_count_u8(function_node, "mipi-sdca-report-descriptor");

		if (nval) {

			report_desc = devm_kzalloc(dev, nval, GFP_KERNEL);

			if (!report_desc)

				return -ENOMEM;

			hide->hid_report_desc = report_desc;

			fwnode_property_read_u8_array(function_node, "mipi-sdca-report-descriptor",

						      report_desc, nval);

		}

	}



	return 0;

}



static int find_sdca_entity(struct device *dev,

			    struct fwnode_handle *function_node,

			    struct fwnode_handle *entity_node,
@@ -1261,6 +1341,9 @@ static int find_sdca_entity(struct device *dev, 
	case SDCA_ENTITY_TYPE_GE:

		ret = find_sdca_entity_ge(dev, entity_node, entity);

		break;

	case SDCA_ENTITY_TYPE_HIDE:

		ret = find_sdca_entity_hide(dev, function_node, entity_node, entity);

		break;

	default:

		break;

	}