Merge branch 'pci/switchtec' into next (d060c6fc) · Commits · e / devices / android_kernel_fairphone_FP4

Documentation/ABI/testing/sysfs-class-switchtec

0 → 100644

+96 −0

Original line number	Diff line number	Diff line
		switchtec - Microsemi Switchtec PCI Switch Management Endpoint

		For details on this subsystem look at Documentation/switchtec.txt.

		What: /sys/class/switchtec
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: The switchtec class subsystem folder.
		Each registered switchtec driver is represented by a switchtecX
		subfolder (X being an integer >= 0).


		What: /sys/class/switchtec/switchtec[0-9]+/component_id
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Component identifier as stored in the hardware (eg. PM8543)
		(read only)
		Values: arbitrary string.


		What: /sys/class/switchtec/switchtec[0-9]+/component_revision
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Component revision stored in the hardware (read only)
		Values: integer.


		What: /sys/class/switchtec/switchtec[0-9]+/component_vendor
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Component vendor as stored in the hardware (eg. MICROSEM)
		(read only)
		Values: arbitrary string.


		What: /sys/class/switchtec/switchtec[0-9]+/device_version
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Device version as stored in the hardware (read only)
		Values: integer.


		What: /sys/class/switchtec/switchtec[0-9]+/fw_version
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Currently running firmware version (read only)
		Values: integer (in hexadecimal).


		What: /sys/class/switchtec/switchtec[0-9]+/partition
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Partition number for this device in the switch (read only)
		Values: integer.


		What: /sys/class/switchtec/switchtec[0-9]+/partition_count
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Total number of partitions in the switch (read only)
		Values: integer.


		What: /sys/class/switchtec/switchtec[0-9]+/product_id
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Product identifier as stored in the hardware (eg. PSX 48XG3)
		(read only)
		Values: arbitrary string.


		What: /sys/class/switchtec/switchtec[0-9]+/product_revision
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Product revision stored in the hardware (eg. RevB)
		(read only)
		Values: arbitrary string.


		What: /sys/class/switchtec/switchtec[0-9]+/product_vendor
		Date: 05-Jan-2017
		KernelVersion: v4.11
		Contact: Logan Gunthorpe <logang@deltatee.com>
		Description: Product vendor as stored in the hardware (eg. MICROSEM)
		(read only)
		Values: arbitrary string.

Documentation/ioctl/ioctl-number.txt

+1 −0

Original line number	Diff line number	Diff line
		@@ -191,6 +191,7 @@ Code Seq#(hex) Include File Comments
		'W' 00-1F linux/watchdog.h conflict!
		'W' 00-1F linux/wanrouter.h conflict! (pre 3.9)
		'W' 00-3F sound/asound.h conflict!
		'W' 40-5F drivers/pci/switch/switchtec.c
		'X' all fs/xfs/xfs_fs.h conflict!
		and fs/xfs/linux-2.6/xfs_ioctl32.h
		and include/linux/falloc.h

Documentation/switchtec.txt

0 → 100644

+80 −0

Original line number	Diff line number	Diff line
		========================
		Linux Switchtec Support
		========================

		Microsemi's "Switchtec" line of PCI switch devices is already
		supported by the kernel with standard PCI switch drivers. However, the
		Switchtec device advertises a special management endpoint which
		enables some additional functionality. This includes:

		* Packet and Byte Counters
		* Firmware Upgrades
		* Event and Error logs
		* Querying port link status
		* Custom user firmware commands

		The switchtec kernel module implements this functionality.


		Interface
		=========

		The primary means of communicating with the Switchtec management firmware is
		through the Memory-mapped Remote Procedure Call (MRPC) interface.
		Commands are submitted to the interface with a 4-byte command
		identifier and up to 1KB of command specific data. The firmware will
		respond with a 4 bytes return code and up to 1KB of command specific
		data. The interface only processes a single command at a time.


		Userspace Interface
		===================

		The MRPC interface will be exposed to userspace through a simple char
		device: /dev/switchtec#, one for each management endpoint in the system.

		The char device has the following semantics:

		* A write must consist of at least 4 bytes and no more than 1028 bytes.
		The first four bytes will be interpreted as the command to run and
		the remainder will be used as the input data. A write will send the
		command to the firmware to begin processing.

		* Each write must be followed by exactly one read. Any double write will
		produce an error and any read that doesn't follow a write will
		produce an error.

		* A read will block until the firmware completes the command and return
		the four bytes of status plus up to 1024 bytes of output data. (The
		length will be specified by the size parameter of the read call --
		reading less than 4 bytes will produce an error.

		* The poll call will also be supported for userspace applications that
		need to do other things while waiting for the command to complete.

		The following IOCTLs are also supported by the device:

		* SWITCHTEC_IOCTL_FLASH_INFO - Retrieve firmware length and number
		of partitions in the device.

		* SWITCHTEC_IOCTL_FLASH_PART_INFO - Retrieve address and lengeth for
		any specified partition in flash.

		* SWITCHTEC_IOCTL_EVENT_SUMMARY - Read a structure of bitmaps
		indicating all uncleared events.

		* SWITCHTEC_IOCTL_EVENT_CTL - Get the current count, clear and set flags
		for any event. This ioctl takes in a switchtec_ioctl_event_ctl struct
		with the event_id, index and flags set (index being the partition or PFF
		number for non-global events). It returns whether the event has
		occurred, the number of times and any event specific data. The flags
		can be used to clear the count or enable and disable actions to
		happen when the event occurs.
		By using the SWITCHTEC_IOCTL_EVENT_FLAG_EN_POLL flag,
		you can set an event to trigger a poll command to return with
		POLLPRI. In this way, userspace can wait for events to occur.

		* SWITCHTEC_IOCTL_PFF_TO_PORT and SWITCHTEC_IOCTL_PORT_TO_PFF convert
		between PCI Function Framework number (used by the event system)
		and Switchtec Logic Port ID and Partition number (which is more
		user friendly).

MAINTAINERS

+11 −0

Original line number	Diff line number	Diff line
		@@ -9664,6 +9664,17 @@ S: Maintained
		F: Documentation/devicetree/bindings/pci/aardvark-pci.txt
		F: drivers/pci/host/pci-aardvark.c

		PCI DRIVER FOR MICROSEMI SWITCHTEC
		M: Kurt Schwemmer <kurt.schwemmer@microsemi.com>
		M: Stephen Bates <stephen.bates@microsemi.com>
		M: Logan Gunthorpe <logang@deltatee.com>
		L: linux-pci@vger.kernel.org
		S: Maintained
		F: Documentation/switchtec.txt
		F: Documentation/ABI/testing/sysfs-class-switchtec
		F: drivers/pci/switch/switchtec*
		F: include/uapi/linux/switchtec_ioctl.h

		PCI DRIVER FOR NVIDIA TEGRA
		M: Thierry Reding <thierry.reding@gmail.com>
		L: linux-tegra@vger.kernel.org

drivers/pci/Kconfig

+1 −0

Original line number	Diff line number	Diff line
		@@ -135,3 +135,4 @@ source "drivers/pci/hotplug/Kconfig"
		source "drivers/pci/dwc/Kconfig"
		source "drivers/pci/host/Kconfig"
		source "drivers/pci/endpoint/Kconfig"
		source "drivers/pci/switch/Kconfig"