input: misc: atmel_ptc: add configuration header stuff

The configuration file starts with a header to allow checking that
it is used with the appropriate firmware and to get details about
the configuration itself.

TODO: Check the firmware version. Consensus needed about the
firmware version string.

Signed-off-by: Ludovic Desroches <ludovic.desroches@microchip.com>

Author: ldesroches

drivers/input/misc/atmel_ptc.c

@@ -84,6 +84,16 @@ static char *firmware_file = ATMEL_PPP_FIRMWARE_NAME;
 static char *configuration_file = ATMEL_QTM_CONF_NAME;
 static bool debug_mode;
 
+struct atmel_qtm_conf_header {
+	u8	header_version_major;
+	u8	header_version_minor;
+	u32	header_size;
+	char	*firmware_version;
+	char	*tool_version;
+	char	*date;
+	char	*description;
+};
+
 /* Depends on firmware version */
 struct atmel_qtm_mailbox_map {
 	unsigned int	cmd_offset;
@@ -114,7 +124,7 @@ struct atmel_qtm_mailbox_map {
 	unsigned int	touch_events_scroller_event_id;
 };
 
-static struct atmel_qtm_mailbox_map mailbox_map_v61 = {
+static struct atmel_qtm_mailbox_map mailbox_map_v63 = {
 	.cmd_offset				= 0x0,
 	.cmd_id_offset				= 0,
 	.cmd_addr_offset			= 2,
@@ -169,6 +179,7 @@ struct atmel_ptc {
 	struct device			*dev;
 	struct input_dev		*buttons_input;
 	struct input_dev		*scroller_input[ATMEL_PTC_MAX_SCROLLERS];
+	struct atmel_qtm_conf_header	conf;
 	struct atmel_qtm_mailbox_map	*mb_map;
 	const struct atmel_ptc_pins	*pins;
 	bool				*x_lines_requested;
@@ -182,7 +193,7 @@ struct atmel_ptc {
 	u32				button_event[ATMEL_PTC_MAX_NODES / 32];
 	u32				button_state[ATMEL_PTC_MAX_NODES / 32];
 	u32				scroller_event;
-	u32				firmware_version;
+	char				*firmware_version;
 };
 
 static void atmel_ppp_irq_enable(struct atmel_ptc *ptc, u8 mask)
@@ -738,6 +749,34 @@ static int atmel_ptc_conf_load(struct atmel_ptc *ptc)
 		return ret;
 	}
 
+	ptc->conf.header_version_major = conf->data[0];
+	ptc->conf.header_version_minor = conf->data[1];
+	switch (ptc->conf.header_version_major) {
+	case (1):
+		ptc->conf.header_size = 96;
+		ptc->conf.firmware_version = (char *) conf->data + 16;
+		ptc->conf.tool_version = (char *) conf->data + 32;
+		ptc->conf.date = (char *) conf->data + 48;
+		ptc->conf.description = (char *) conf->data + 64;
+		break;
+	default:
+		release_firmware(conf);
+		dev_err(ptc->dev, "Unsupported header version: %u.%u\n",
+			ptc->conf.header_version_major,
+			ptc->conf.header_version_minor);
+		return -EINVAL;
+	};
+
+	dev_info(ptc->dev, "firmware version: %s, tool version: %s\n",
+		 ptc->conf.firmware_version, ptc->conf.tool_version);
+	dev_info(ptc->dev, "date: %s, description: %s\n",
+		 ptc->conf.date, ptc->conf.description);
+
+	/*
+	 * TODO: check the version of the firmware loaded vs the version of the
+	 * firmware needed by the configuration file.
+	 */
+
 	atmel_ppp_irq_enable(ptc, ATMEL_PPP_IRQ1);
 	atmel_ppp_irq_disable(ptc, ATMEL_PPP_IRQ2 | ATMEL_PPP_IRQ3);
 
@@ -746,7 +785,8 @@ static int atmel_ptc_conf_load(struct atmel_ptc *ptc)
 
 	dst = (char *)ptc->qtm_mb;
 	/* Need to use _memcpy_toio, otherwise configuration is not well loaded. */
-	_memcpy_toio(dst, conf->data + 64, conf->size - 64); /* Header size, cleanup needed. */
+	_memcpy_toio(dst, conf->data + ptc->conf.header_size,
+		     conf->size - ptc->conf.header_size);
 
 	key_count = atmel_qtm_get_key_count(ptc);
 
@@ -771,7 +811,6 @@ static int atmel_ptc_conf_load(struct atmel_ptc *ptc)
 static int atmel_ptc_fw_load(struct atmel_ptc *ptc)
 {
 	const struct firmware *fw;
-	struct atmel_qtm_cmd cmd;
 	int ret;
 
 	dev_dbg(ptc->dev, "loading firmware: %s\n", firmware_file);
@@ -781,16 +820,13 @@ static int atmel_ptc_fw_load(struct atmel_ptc *ptc)
 		return ret;
 	}
 
-	/* TODO */
-	ptc->firmware_version = 61;
-	dev_dbg(ptc->dev, "firmware version: %u\n", ptc->firmware_version);
+	/* TODO: ptc->firmware_version = */
+	ptc->firmware_version = "PPP_VER_6.3";
 
-	switch (ptc->firmware_version) {
-	case 61:
-		ptc->mb_map = &mailbox_map_v61;
-		break;
-	default:
-		dev_err(ptc->dev, "unsupported firmware version: %u\n", ptc->firmware_version);
+	if (!strcmp(ptc->firmware_version, "PPP_VER_6.3")) {
+		ptc->mb_map = &mailbox_map_v63;
+	} else {
+		dev_err(ptc->dev, "unsupported firmware version: %s\n", ptc->firmware_version);
 		ret = -EINVAL;
 		goto out;
 	}
@@ -808,13 +844,6 @@ static int atmel_ptc_fw_load(struct atmel_ptc *ptc)
 
 	atmel_ppp_cmd_send(ptc, ATMEL_PPP_CMD_RUN);
 
-	cmd.id = ATMEL_QTM_CMD_FIRM_VERSION;
-	atmel_ptc_cmd_send(ptc, &cmd);
-	if (cmd.data != ptc->firmware_version) {
-		dev_err(ptc->dev, "invalid firmware\n");
-		ret = -EINVAL;
-	}
-
 out:
 	release_firmware(fw);
 	return ret;