Skip to contentSkip to conversation

drivers/misc: Add Intel System ID driver

PATCH Greg KH 3 participants 11 messages Feb 15, 2017 – Mar 2, 2017 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): 1487156981-4550-1-git-send-email-user@thloh-VirtualBox

Greg KH

author
#1 lore raw
Quoted 9 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Quoted 97 lines
---
 drivers/misc/Kconfig       |    5 ++
 drivers/misc/Makefile      |    1 +
 drivers/misc/intel_sysid.c |  142 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 148 insertions(+), 0 deletions(-)
 create mode 100644 drivers/misc/intel_sysid.c
drivers/misc/Kconfig +5 -0
index b4d6aac..e5552fa 100644
@@ -139,6 +139,11 @@ config INTEL_MID_PTI
 	  an Intel Atom (non-netbook) mobile device containing a MIPI
 	  P1149.7 standard implementation.
 
+config INTEL_SYSID
+        tristate "Intel System ID"
+        help
+        This enables Intel System ID soft core driver.
+
 config SGI_IOC4
 	tristate "SGI IOC4 Base IO support"
 	depends on PCI
drivers/misc/Makefile +1 -0
index 7a3ea89..24fe724 100644
@@ -43,6 +43,7 @@ obj-y				+= ti-st/
 obj-y				+= lis3lv02d/
 obj-$(CONFIG_USB_SWITCH_FSA9480) += fsa9480.o
 obj-$(CONFIG_ALTERA_STAPL)	+=altera-stapl/
+obj-$(CONFIG_INTEL_SYSID)       += intel_sysid.o
 obj-$(CONFIG_INTEL_MEI)		+= mei/
 obj-$(CONFIG_VMWARE_VMCI)	+= vmw_vmci/
 obj-$(CONFIG_LATTICE_ECP3_CONFIG)	+= lattice-ecp3-config.o
drivers/misc/intel_sysid.c new file +54 -0
new file mode 100644
index 0000000..1ef72b8
@@ -0,0 +1,142 @@
+/*
+ * Copyright Intel Corporation (C) 2017.
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope 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
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Credit:
+ * Walter Goossens
+ */
+
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/io.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+
+#define DRV_NAME	"intel_sysid"
+
+struct intel_sysid {
+	void __iomem		*regs;
+};
+
+/* System ID Registers*/
+#define SYSID_REG_ID		(0x0)
+#define SYSID_REG_TIMESTAMP	(0x4)
+
+static ssize_t intel_sysid_show_id(struct device *dev,
+		struct device_attribute *attr, char *buf)
+{
+	struct intel_sysid *sysid = dev_get_drvdata(dev);
+
+	return sprintf(buf, "%u\n", readl(sysid->regs + SYSID_REG_ID));
+}
+
+static ssize_t intel_sysid_show_timestamp(struct device *dev,
+		struct device_attribute *attr, char *buf)
+{
+	unsigned int reg;
+	struct tm timestamp;
+	struct intel_sysid *sysid = dev_get_drvdata(dev);
+
+	reg = readl(sysid->regs + SYSID_REG_TIMESTAMP);
+

drivers/misc/intel_sysid.c line 64

Quoted 10 lines
drivers/misc/intel_sysid.c new file +10 -0
+	time_to_tm(reg, 0, &timestamp);
+
+	return sprintf(buf, "%u (%u-%u-%u %u:%u:%u UTC)\n", reg,
+		(unsigned int)(timestamp.tm_year + 1900),
+		timestamp.tm_mon + 1, timestamp.tm_mday, timestamp.tm_hour,
+		timestamp.tm_min, timestamp.tm_sec);
+}
+
+static DEVICE_ATTR(id, S_IRUGO, intel_sysid_show_id, NULL);
+static DEVICE_ATTR(timestamp, S_IRUGO, intel_sysid_show_timestamp, NULL);

DEVICE_ATTR_RO()?

drivers/misc/intel_sysid.c line 74

Quoted 10 lines
drivers/misc/intel_sysid.c new file +10 -0
+static struct attribute *intel_sysid_attrs[] = {
+	&dev_attr_id.attr,
+	&dev_attr_timestamp.attr,
+	NULL,
+};
+
+struct attribute_group intel_sysid_attr_group = {
+	.name = "sysid",
+	.attrs = intel_sysid_attrs,
+};

ATTRIBUTE_GROUP()?

thanks,

greg k-h

#2 lore raw
Quoted 7 lines · Greg KH
Quoted 6 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Quoted 6 lines
Quoted 3 lines

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Maybe we could pretend that this is for a SoC and use the standard soc_device attributes as well as moving the driver into drivers/soc/?

Arnd

#3 lore raw

Sorry for the late reply.
This driver can currently be used by ARM and Nios II, so moving it into drivers/soc might not be the best idea.

Thanks
Tien Hock

Quoted 21 lines · Arnd Bergmann
Quoted 9 lines · Greg KH
Quoted 7 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Quoted 5 lines
Quoted 3 lines

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Maybe we could pretend that this is for a SoC and use the standard soc_device
attributes as well as moving the driver into drivers/soc/?

     Arnd

#4 lore raw
Quoted 18 lines · Tien Hock
Quoted 17 lines · Arnd Bergmann
Quoted 14 lines · Greg KH
Quoted 10 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Quoted 6 lines
Quoted 3 lines

Maybe we could pretend that this is for a SoC and use the standard soc_device
attributes as well as moving the driver into drivers/soc/?> Sorry for the late reply.

This driver can currently be used by ARM and Nios II, so moving it into drivers/soc might not be the best idea.

Why not? drivers/soc/ was specifically introduced for stuff that is used on some SoC but across more than one architecture (otherwise it would be in arch/foo/). This seems to fit perfectly.

Arnd

#5 lore raw

OK then I'll move it into driver/soc/ in that case.

Quoted 38 lines · Arnd Bergmann
Quoted 22 lines · Tien Hock
Quoted 20 lines · Arnd Bergmann
Quoted 16 lines · Greg KH
Quoted 11 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Quoted 8 lines
Quoted 5 lines

Maybe we could pretend that this is for a SoC and use the standard
soc_device
attributes as well as moving the driver into drivers/soc/?> Sorry for the late reply.

This driver can currently be used by ARM and Nios II, so moving it into
drivers/soc might not be the best idea.

Why not? drivers/soc/ was specifically introduced for stuff that is used on
some SoC but across more than one architecture (otherwise it would be in arch/foo/). This seems to fit perfectly.

     Arnd

#6 lore raw

Arnd, Greg,

I checked the attributes returned by the soc attribute subsystem, but it seems that it is lacking something equivalent to timestamp in the Intel System ID controller. Do you think it is better to add a new attribute (named timestamp) to soc or create a new sysfs entry like what I did?

Thanks
Tien Hock

Quoted 52 lines · Tien Hock

OK then I'll move it into driver/soc/ in that case.

Quoted 49 lines · Arnd Bergmann
Quoted 34 lines · Tien Hock
Quoted 23 lines · Arnd Bergmann

On Wed, Feb 15, 2017 at 6:17 PM, Greg KH <gregkh@linuxfoundatio n.
org>

Quoted 17 lines · wrote:
Quoted 13 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver. User can obtain the system ID and timestamp of the system by
reading the sysfs entry.

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

Quoted 8 lines
Quoted 2 lines

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Maybe we could pretend that this is for a SoC and use the standard
soc_device
attributes as well as moving the driver into drivers/soc/?> Sorry
for the late reply.

Quoted 4 lines

This driver can currently be used by ARM and Nios II, so moving it
into
drivers/soc might not be the best idea.

Why not? drivers/soc/ was specifically introduced for stuff that is used on
some SoC but across more than one architecture (otherwise it would be
in arch/foo/). This seems to fit perfectly.

     Arnd

#7 lore raw
Quoted 1 line · Tien Hock

Arnd, Greg,

Please don't top-post.

Quoted 5 lines

I checked the attributes returned by the soc attribute subsystem, but it seems that it is lacking something equivalent to timestamp in the Intel System ID controller. Do you think it is better to add a new attribute (named timestamp) to soc or create a new sysfs entry like what I did?

It depends on how common and how important this attribute is.

- if it's not overly important, just drop it entirely.
- if it's important enough that other SoCs are likely to have the same kind of information, make it a standard attribute
- if this SoC is most likely the only one that will ever need it, but it has important uses, I'd make it a custom attribute

Another option would be to fold the timestamp into the revision attribute, but whether that is a reasonable place for it would in turn depend on what the timestamp signifies.

Can you explain what the timestamp is used for? Does it identify the time that the hardware revision was made, the time that a software was built which was loaded into it, or something else? What kind of user space application would need this information?

Arnd

#8 lore raw
Quoted 5 lines · Arnd Bergmann
Quoted 2 lines · Tien Hock

Arnd, Greg,

Please don't top-post.

OK.

Quoted 24 lines
Quoted 9 lines

I checked the attributes returned by the soc attribute subsystem, but
it seems that it is lacking something equivalent to timestamp in the
Intel System ID controller. Do you think it is better to add a new attribute (named timestamp) to soc or create a new sysfs entry like what I did?

It depends on how common and how important this attribute is.

- if it's not overly important, just drop it entirely.
- if it's important enough that other SoCs are likely to have the same
  kind of information, make it a standard attribute
- if this SoC is most likely the only one that will ever need it, but it has
  important uses, I'd make it a custom attribute

Another option would be to fold the timestamp into the revision attribute,
but whether that is a reasonable place for it would in turn depend on what the timestamp signifies.

Quoted 4 lines

Can you explain what the timestamp is used for? Does it identify the time that the hardware revision was made, the time that a software was built which was loaded into it, or something else? What kind of user space application would need this information?

I just checked, and it seems like we can't put this into soc subsystem. In FPGA, we now can do partial reconfiguration, which "reconfigures" the hardware to have an updated sysid and timestamp value, and the base address of the Intel System ID may also be changed. This would require the driver to be a module that will be removed, probed again. The soc subsystem doesn't seem to be a suitable place to add this driver.

A note on the timestamp, in the old days this is used to check that the BSP is using the correct FPGA hardware. I believe in Linux we should do the same in the driver, and if it not, the driver should print a warning. The timestamp's print is not exactly needed. I'll add the feature into the driver in the next patch.

Quoted 2 lines

     Arnd

Thanks
Tien Hock

#9 lore raw
Quoted 12 lines · Tien Hock
Quoted 10 lines · Arnd Bergmann

On Wed, Mar 1, 2017 at 8:23 AM, Loh, Tien Hock <[email protected] Another option would be to fold the timestamp into the revision attribute,
but whether that is a reasonable place for it would in turn depend on what the timestamp signifies.

Can you explain what the timestamp is used for? Does it identify the time that the hardware revision was made, the time that a software was built which was loaded into it, or something else? What kind of user space application would need this information?

Quoted 6 lines

I just checked, and it seems like we can't put this into soc subsystem. In FPGA, we now can do partial reconfiguration, which "reconfigures" the hardware to have an updated sysid and timestamp value, and the base address of the Intel System ID may also be changed. This would require the driver to be a module that will be removed, probed again. The soc subsystem doesn't seem to be a suitable place to add this driver.

Ah, I had not realized this is for fpga_manager.

Why not put the attributes into /sys/class/fpga_manager/*/ then along with the other attributes that exist there? That way, we have an interface that works for all users of drivers/fpga/

Quoted 5 lines

A note on the timestamp, in the old days this is used to check that the BSP is using the correct FPGA hardware. I believe in Linux we should do the same in the driver, and if it not, the driver should print a warning. The timestamp's print is not exactly needed. I'll add the feature into the driver in the next patch.

Ok.

Arnd

#10 lore raw
Quoted 30 lines · Arnd Bergmann
Quoted 17 lines · Tien Hock
Quoted 9 lines · Arnd Bergmann

On Wed, Mar 1, 2017 at 8:23 AM, Loh, Tien Hock <tien.hock.loh@int el.c
Another option would be to fold the timestamp into the revision attribute,
but whether that is a reasonable place for it would in turn depend on
what the timestamp signifies.

Quoted 6 lines

Can you explain what the timestamp is used for? Does it identify the
time that the hardware revision was made, the time that a software
was built which was loaded into it, or something else? What kind of user space application would need this information?

Quoted 11 lines

I just checked, and it seems like we can't put this into soc subsystem.
In FPGA, we now can do partial reconfiguration, which "reconfigures"
the hardware to have an updated sysid and timestamp value, and the base
address of the Intel System ID may also be changed. This would require
the driver to be a module that will be removed, probed again. The soc
subsystem doesn't seem to be a suitable place to add this driver.

Quoted 6 lines

Ah, I had not realized this is for fpga_manager.

Why not put the attributes into /sys/class/fpga_manager/*/ then along with the other attributes that exist there? That way, we have an interface that works for all users of drivers/fpga/

Well, this is not only for fpga_manager, but often time used to ensure that the correct hardware is programmed into the FPGA by checking the sysid after fpga_manager reconfigures the hardware. Systems without fpga_manager can still use sysid and timestamp to ensure the hardware is as expected value.

What do you think of /sys/class/fpga_sysid/*/id and /sys/class/fpga_sysid/*/timestamp?

Quoted 11 lines
Quoted 8 lines

A note on the timestamp, in the old days this is used to check that the
BSP is using the correct FPGA hardware. I believe in Linux we should do
the same in the driver, and if it not, the driver should print a warning. The timestamp's print is not exactly needed. I'll add the feature into the driver in the next patch.

Ok.

     Arnd

#11 lore raw
In reply to Greg KH

Sorry for the late reply. I'll add the Documentation/ABI description, use DEVICE_ATTR_RO and update ATTRIBUTE_GROUP.

Thanks
Tien Hock

Quoted 152 lines · Greg KH
Quoted 10 lines · thloh

From: "Loh, Tien Hock" <[email protected]>

This patch is to add Altera System ID driver.
User can obtain the system ID and timestamp of the system by reading the sysfs entry.

Usage:
cat /sys/bus/platform/devices/[addr].sysid/sysid/id cat /sys/bus/platform/devices/[addr].sysid/sysid/timestamp

If you add new sysfs attributes, you need to also add a Documentation/ABI/ description as well.

Quoted 119 lines

---
 drivers/misc/Kconfig       |    5 ++
 drivers/misc/Makefile      |    1 +
 drivers/misc/intel_sysid.c |  142
++++++++++++++++++++++++++++++++++++++++++++

 3 files changed, 148 insertions(+), 0 deletions(-)

 create mode 100644 drivers/misc/intel_sysid.c

drivers/misc/Kconfig +0 -0
index b4d6aac..e5552fa 100644
@@ -139,6 +139,11 @@ config INTEL_MID_PTI

    an Intel Atom (non-netbook) mobile device containing a MIPI
    P1149.7 standard implementation.

drivers/misc/Kconfig +5 -0
+config INTEL_SYSID
+        tristate "Intel System ID"
+        help
+        This enables Intel System ID soft core driver.
+

 config SGI_IOC4
  tristate "SGI IOC4 Base IO support"
  depends on PCI

drivers/misc/Makefile +0 -0
index 7a3ea89..24fe724 100644
@@ -43,6 +43,7 @@ obj-y				+= ti-st/

 obj-y += lis3lv02d/
 obj-$(CONFIG_USB_SWITCH_FSA9480) += fsa9480.o
 obj-$(CONFIG_ALTERA_STAPL) +=altera-stapl/
+obj-$(CONFIG_INTEL_SYSID)       += intel_sysid.o
 obj-$(CONFIG_INTEL_MEI) += mei/
 obj-$(CONFIG_VMWARE_VMCI) += vmw_vmci/
 obj-$(CONFIG_LATTICE_ECP3_CONFIG) += lattice-ecp3-config.o

drivers/misc/intel_sysid.c new file +4 -0
new file mode 100644
index 0000000..1ef72b8
@@ -0,0 +1,142 @@
+/*
+ * Copyright Intel Corporation (C) 2017.
+ *
+ * This program is free software; you can redistribute it and/or

modify it
+ * under the terms and conditions of the GNU General Public License,
+ * version 2, as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope 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
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Credit:
+ * Walter Goossens
+ */

drivers/misc/intel_sysid.c new file +25 -0
+
+#include <linux/device.h>
+#include <linux/kernel.h>
+#include <linux/io.h>
+#include <linux/module.h>
+#include <linux/of.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+
+#define DRV_NAME	"intel_sysid"
+
+struct intel_sysid {
+	void __iomem		*regs;
+};
+
+/* System ID Registers*/
+#define SYSID_REG_ID		(0x0)
+#define SYSID_REG_TIMESTAMP	(0x4)
+
+static ssize_t intel_sysid_show_id(struct device *dev,
+		struct device_attribute *attr, char *buf)
+{
+	struct intel_sysid *sysid = dev_get_drvdata(dev);
+
+	return sprintf(buf, "%u\n", readl(sysid->regs +

SYSID_REG_ID));

drivers/misc/intel_sysid.c new file +16 -0
+}
+
+static ssize_t intel_sysid_show_timestamp(struct device *dev,
+		struct device_attribute *attr, char *buf)
+{
+	unsigned int reg;
+	struct tm timestamp;
+	struct intel_sysid *sysid = dev_get_drvdata(dev);
+
+	reg = readl(sysid->regs + SYSID_REG_TIMESTAMP);
+
+	time_to_tm(reg, 0, &timestamp);
+
+	return sprintf(buf, "%u (%u-%u-%u %u:%u:%u UTC)\n", reg,
+		(unsigned int)(timestamp.tm_year + 1900),
+		timestamp.tm_mon + 1, timestamp.tm_mday,

timestamp.tm_hour,

drivers/misc/intel_sysid.c new file +5 -0
+		timestamp.tm_min, timestamp.tm_sec);
+}
+
+static DEVICE_ATTR(id, S_IRUGO, intel_sysid_show_id, NULL);
+static DEVICE_ATTR(timestamp, S_IRUGO, intel_sysid_show_timestamp,
Quoted 1 line

NULL);

DEVICE_ATTR_RO()?

drivers/misc/intel_sysid.c

Quoted 11 lines
drivers/misc/intel_sysid.c new file +10 -0
+static struct attribute *intel_sysid_attrs[] = {
+	&dev_attr_id.attr,
+	&dev_attr_timestamp.attr,
+	NULL,
+};
+
+struct attribute_group intel_sysid_attr_group = {
+	.name = "sysid",
+	.attrs = intel_sysid_attrs,
+};

ATTRIBUTE_GROUP()?

thanks,

greg k-h