misc: Add IHS FPGA driver
authorMario Six <mario.six@gdsys.cc>
Thu, 4 Oct 2018 07:00:55 +0000 (09:00 +0200)
committerSimon Glass <sjg@chromium.org>
Wed, 14 Nov 2018 17:16:27 +0000 (09:16 -0800)
Add a driver for gdsys IHS (Integrated Hardware Systems) FPGAs, which
supports initialization of the FPGA, as well as information gathering.

Reviewed-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Mario Six <mario.six@gdsys.cc>
Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt [new file with mode: 0644]
Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt [new file with mode: 0644]
drivers/misc/Kconfig
drivers/misc/Makefile
drivers/misc/ihs_fpga.c [new file with mode: 0644]
drivers/misc/ihs_fpga.h [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt b/Documentation/devicetree/bindings/misc/gdsys,iocon_fpga.txt
new file mode 100644 (file)
index 0000000..acd466f
--- /dev/null
@@ -0,0 +1,19 @@
+gdsys IHS FPGA for CON devices
+
+The gdsys IHS FPGA is the main FPGA on gdsys CON devices. This driver provides
+support for enabling and starting the FPGA, as well as verifying working bus
+communication.
+
+Required properties:
+- compatible: must be "gdsys,iocon_fpga"
+- reset-gpios: List of GPIOs controlling the FPGA's reset
+- done-gpios: List of GPIOs notifying whether the FPGA's reconfiguration is
+              done
+
+Example:
+
+FPGA0 {
+       compatible = "gdsys,iocon_fpga";
+       reset-gpios = <&PPCPCA 26 0>;
+       done-gpios = <&GPIO_VB0 19 0>;
+};
diff --git a/Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt b/Documentation/devicetree/bindings/misc/gdsys,iocpu_fpga.txt
new file mode 100644 (file)
index 0000000..819db22
--- /dev/null
@@ -0,0 +1,19 @@
+gdsys IHS FPGA for CPU devices
+
+The gdsys IHS FPGA is the main FPGA on gdsys CPU devices. This driver provides
+support for enabling and starting the FPGA, as well as verifying working bus
+communication.
+
+Required properties:
+- compatible: must be "gdsys,iocpu_fpga"
+- reset-gpios: List of GPIOs controlling the FPGA's reset
+- done-gpios: List of GPIOs notifying whether the FPGA's reconfiguration is
+              done
+
+Example:
+
+FPGA0 {
+       compatible = "gdsys,iocpu_fpga";
+       reset-gpios = <&PPCPCA 26 0>;
+       done-gpios = <&GPIO_VB0 19 0>;
+};
index d589f32a55e46e7f135e38847b2f891858e5c7ba..48febc47d263b9be2dd1439901e6fe03ba581062 100644 (file)
@@ -320,4 +320,13 @@ config GDSYS_SOC
          IHS (Integrated Hardware Systems) FPGA, which holds all devices whose
          register maps are contained within the FPGA's register map.
 
+config IHS_FPGA
+       bool "Enable IHS FPGA driver"
+       depends on MISC
+       help
+         Support IHS (Integrated Hardware Systems) FPGA, the main FPGAs on
+         gdsys devices, which supply the majority of the functionality offered
+         by the devices. This driver supports both CON and CPU variants of the
+         devices, depending on the device tree entry.
+
 endmenu
index 4a5a18675a0c4a2bb157993b29cc8c320f4e190c..302d4415927431ab593eea03b4c2366fcc22ff67 100644 (file)
@@ -37,6 +37,7 @@ obj-$(CONFIG_GDSYS_IOEP) += gdsys_ioep.o
 obj-$(CONFIG_GDSYS_RXAUI_CTRL) += gdsys_rxaui_ctrl.o
 obj-$(CONFIG_GDSYS_SOC) += gdsys_soc.o
 obj-$(CONFIG_$(SPL_)I2C_EEPROM) += i2c_eeprom.o
+obj-$(CONFIG_IHS_FPGA) += ihs_fpga.o
 obj-$(CONFIG_IMX8) += imx8/
 obj-$(CONFIG_LED_STATUS) += status_led.o
 obj-$(CONFIG_LED_STATUS_GPIO) += gpio_led.o
diff --git a/drivers/misc/ihs_fpga.c b/drivers/misc/ihs_fpga.c
new file mode 100644 (file)
index 0000000..f9e4b27
--- /dev/null
@@ -0,0 +1,867 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * (C) Copyright 2017
+ * Mario Six,  Guntermann & Drunck GmbH, mario.six@gdsys.cc
+ *
+ * based on the ioep-fpga driver, which is
+ *
+ * (C) Copyright 2014
+ * Dirk Eibach,  Guntermann & Drunck GmbH, eibach@gdsys.de
+ */
+
+#include <common.h>
+#include <dm.h>
+#include <regmap.h>
+#include <asm/gpio.h>
+
+#include "ihs_fpga.h"
+
+/**
+ * struct ihs_fpga_priv - Private data structure for IHS FPGA driver
+ * @map:        Register map for the FPGA's own register space
+ * @reset_gpio: GPIO to start FPGA reconfiguration
+ * @done_gpio:  GPOI to read the 'ready' status of the FPGA
+ */
+struct ihs_fpga_priv {
+       struct regmap *map;
+       struct gpio_desc reset_gpio;
+       struct gpio_desc done_gpio;
+};
+
+/* Test pattern for reflection test */
+const u16 REFLECTION_TESTPATTERN = 0xdead;
+/* Delay (in ms) for each round in the reflection test */
+const uint REFLECTION_TEST_DELAY = 100;
+/* Maximum number of rounds in the reflection test */
+const uint REFLECTION_TEST_ROUNDS = 5;
+/* Delay (in ms) for each round waiting for the FPGA's done GPIO */
+const uint FPGA_DONE_WAIT_DELAY = 100;
+/* Maximum number of rounds for waiting for the FPGA's done GPIO */
+const uint FPGA_DONE_WAIT_ROUND = 5;
+
+/**
+ * enum pcb_video_type - Video type of the PCB
+ * @PCB_DVI_SL:     Video type is DVI single-link
+ * @PCB_DP_165MPIX: Video type is DisplayPort (165Mpix)
+ * @PCB_DP_300MPIX: Video type is DisplayPort (300Mpix)
+ * @PCB_HDMI:       Video type is HDMI
+ * @PCB_DP_1_2:     Video type is DisplayPort 1.2
+ * @PCB_HDMI_2_0:   Video type is HDMI 2.0
+ */
+enum pcb_video_type {
+       PCB_DVI_SL,
+       PCB_DP_165MPIX,
+       PCB_DP_300MPIX,
+       PCB_HDMI,
+       PCB_DP_1_2,
+       PCB_HDMI_2_0,
+};
+
+/**
+ * enum pcb_transmission_type - Transmission type of the PCB
+ * @PCB_CAT_1G:    Transmission type is 1G Ethernet
+ * @PCB_FIBER_3G:  Transmission type is 3G Fiber
+ * @PCB_CAT_10G:   Transmission type is 10G Ethernet
+ * @PCB_FIBER_10G: Transmission type is 10G Fiber
+ */
+enum pcb_transmission_type {
+       PCB_CAT_1G,
+       PCB_FIBER_3G,
+       PCB_CAT_10G,
+       PCB_FIBER_10G,
+};
+
+/**
+ * enum carrier_speed - Speed of the FPGA's carrier
+ * @CARRIER_SPEED_1G:   The carrier speed is 1G
+ * @CARRIER_SPEED_2_5G: The carrier speed is 2.5G
+ * @CARRIER_SPEED_3G:   The carrier speed is 3G
+ * @CARRIER_SPEED_10G:  The carrier speed is 10G
+ */
+enum carrier_speed {
+       CARRIER_SPEED_1G,
+       CARRIER_SPEED_3G,
+       CARRIER_SPEED_2_5G = CARRIER_SPEED_3G,
+       CARRIER_SPEED_10G,
+};
+
+/**
+ * enum ram_config - FPGA's RAM configuration
+ * @RAM_DDR2_32BIT_295MBPS:  DDR2 32 bit at 295Mb/s
+ * @RAM_DDR3_32BIT_590MBPS:  DDR3 32 bit at 590Mb/s
+ * @RAM_DDR3_48BIT_590MBPS:  DDR3 48 bit at 590Mb/s
+ * @RAM_DDR3_64BIT_1800MBPS: DDR3 64 bit at 1800Mb/s
+ * @RAM_DDR3_48BIT_1800MBPS: DDR3 48 bit at 1800Mb/s
+ */
+enum ram_config {
+       RAM_DDR2_32BIT_295MBPS,
+       RAM_DDR3_32BIT_590MBPS,
+       RAM_DDR3_48BIT_590MBPS,
+       RAM_DDR3_64BIT_1800MBPS,
+       RAM_DDR3_48BIT_1800MBPS,
+};
+
+/**
+ * enum sysclock - Speed of the FPGA's system clock
+ * @SYSCLK_147456: System clock is 147.456 MHz
+ */
+enum sysclock {
+       SYSCLK_147456,
+};
+
+/**
+ * struct fpga_versions - Data read from the versions register
+ * @video_channel:        Is the FPGA for a video channel (true) or main
+ *                        channel (false) device?
+ * @con_side:             Is the FPGA for a CON (true) or a CPU (false) device?
+ * @pcb_video_type:       Defines for whch video type the FPGA is configured
+ * @pcb_transmission_type: Defines for which transmission type the FPGA is
+ *                        configured
+ * @hw_version:                   Hardware version of the FPGA
+ */
+struct fpga_versions {
+       bool video_channel;
+       bool con_side;
+       enum pcb_video_type pcb_video_type;
+       enum pcb_transmission_type pcb_transmission_type;
+       unsigned int hw_version;
+};
+
+/**
+ * struct fpga_features - Data read from the features register
+ * @video_channels:    Number of video channels supported
+ * @carriers:          Number of carrier channels supported
+ * @carrier_speed:     Speed of carriers
+ * @ram_config:                RAM configuration of FPGA
+ * @sysclock:          System clock speed of FPGA
+ * @pcm_tx:            Support for PCM transmission
+ * @pcm_rx:            Support for PCM reception
+ * @spdif_tx:          Support for SPDIF audio transmission
+ * @spdif_rx:          Support for SPDIF audio reception
+ * @usb2:              Support for transparent USB2.0
+ * @rs232:             Support for bidirectional RS232
+ * @compression_type1: Support for compression type 1
+ * @compression_type2: Support for compression type 2
+ * @compression_type3: Support for compression type 3
+ * @interlace:         Support for interlace image formats
+ * @osd:               Support for a OSD
+ * @compression_pipes: Number of compression pipes supported
+ */
+struct fpga_features {
+       u8 video_channels;
+       u8 carriers;
+       enum carrier_speed carrier_speed;
+       enum ram_config ram_config;
+       enum sysclock sysclock;
+       bool pcm_tx;
+       bool pcm_rx;
+       bool spdif_tx;
+       bool spdif_rx;
+       bool usb2;
+       bool rs232;
+       bool compression_type1;
+       bool compression_type2;
+       bool compression_type3;
+       bool interlace;
+       bool osd;
+       bool compression_pipes;
+};
+
+#ifdef CONFIG_SYS_FPGA_FLAVOR_GAZERBEAM
+
+/**
+ * get_versions() - Fill structure with info from version register.
+ * @dev:      FPGA device to be queried for information
+ * @versions: Pointer to the structure to fill with information from the
+ *           versions register
+ * Return: 0
+ */
+static int get_versions(struct udevice *dev, struct fpga_versions *versions)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       enum {
+               VERSIONS_FPGA_VIDEO_CHANNEL = BIT(12),
+               VERSIONS_FPGA_CON_SIDE = BIT(13),
+               VERSIONS_FPGA_SC = BIT(14),
+               VERSIONS_PCB_CON = BIT(9),
+               VERSIONS_PCB_SC = BIT(8),
+               VERSIONS_PCB_VIDEO_MASK = 0x3 << 6,
+               VERSIONS_PCB_VIDEO_DP_1_2 = 0x0 << 6,
+               VERSIONS_PCB_VIDEO_HDMI_2_0 = 0x1 << 6,
+               VERSIONS_PCB_TRANSMISSION_MASK = 0x3 << 4,
+               VERSIONS_PCB_TRANSMISSION_FIBER_10G = 0x0 << 4,
+               VERSIONS_PCB_TRANSMISSION_CAT_10G = 0x1 << 4,
+               VERSIONS_PCB_TRANSMISSION_FIBER_3G = 0x2 << 4,
+               VERSIONS_PCB_TRANSMISSION_CAT_1G = 0x3 << 4,
+               VERSIONS_HW_VER_MASK = 0xf << 0,
+       };
+       u16 raw_versions;
+
+       memset(versions, 0, sizeof(struct fpga_versions));
+
+       ihs_fpga_get(priv->map, versions, &raw_versions);
+
+       versions->video_channel = raw_versions & VERSIONS_FPGA_VIDEO_CHANNEL;
+       versions->con_side = raw_versions & VERSIONS_FPGA_CON_SIDE;
+
+       switch (raw_versions & VERSIONS_PCB_VIDEO_MASK) {
+       case VERSIONS_PCB_VIDEO_DP_1_2:
+               versions->pcb_video_type = PCB_DP_1_2;
+               break;
+
+       case VERSIONS_PCB_VIDEO_HDMI_2_0:
+               versions->pcb_video_type = PCB_HDMI_2_0;
+               break;
+       }
+
+       switch (raw_versions & VERSIONS_PCB_TRANSMISSION_MASK) {
+       case VERSIONS_PCB_TRANSMISSION_FIBER_10G:
+               versions->pcb_transmission_type = PCB_FIBER_10G;
+               break;
+
+       case VERSIONS_PCB_TRANSMISSION_CAT_10G:
+               versions->pcb_transmission_type = PCB_CAT_10G;
+               break;
+
+       case VERSIONS_PCB_TRANSMISSION_FIBER_3G:
+               versions->pcb_transmission_type = PCB_FIBER_3G;
+               break;
+
+       case VERSIONS_PCB_TRANSMISSION_CAT_1G:
+               versions->pcb_transmission_type = PCB_CAT_1G;
+               break;
+       }
+
+       versions->hw_version = raw_versions & VERSIONS_HW_VER_MASK;
+
+       return 0;
+}
+
+/**
+ * get_features() - Fill structure with info from features register.
+ * @dev:      FPGA device to be queried for information
+ * @features: Pointer to the structure to fill with information from the
+ *           features register
+ * Return: 0
+ */
+static int get_features(struct udevice *dev, struct fpga_features *features)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       enum {
+               FEATURE_SPDIF_RX = BIT(15),
+               FEATURE_SPDIF_TX = BIT(14),
+               FEATURE_PCM_RX = BIT(13),
+               FEATURE_PCM_TX = BIT(12),
+               FEATURE_RAM_MASK = GENMASK(11, 8),
+               FEATURE_RAM_DDR2_32BIT_295MBPS = 0x0 << 8,
+               FEATURE_RAM_DDR3_32BIT_590MBPS = 0x1 << 8,
+               FEATURE_RAM_DDR3_48BIT_590MBPS = 0x2 << 8,
+               FEATURE_RAM_DDR3_64BIT_1800MBPS = 0x3 << 8,
+               FEATURE_RAM_DDR3_48BIT_1800MBPS = 0x4 << 8,
+               FEATURE_CARRIER_SPEED_MASK = GENMASK(7, 6),
+               FEATURE_CARRIER_SPEED_1G = 0x0 << 6,
+               FEATURE_CARRIER_SPEED_2_5G = 0x1 << 6,
+               FEATURE_CARRIER_SPEED_10G = 0x2 << 6,
+               FEATURE_CARRIERS_MASK = GENMASK(5, 4),
+               FEATURE_CARRIERS_0 = 0x0 << 4,
+               FEATURE_CARRIERS_1 = 0x1 << 4,
+               FEATURE_CARRIERS_2 = 0x2 << 4,
+               FEATURE_CARRIERS_4 = 0x3 << 4,
+               FEATURE_USB2 = BIT(3),
+               FEATURE_VIDEOCHANNELS_MASK = GENMASK(2, 0),
+               FEATURE_VIDEOCHANNELS_0 = 0x0 << 0,
+               FEATURE_VIDEOCHANNELS_1 = 0x1 << 0,
+               FEATURE_VIDEOCHANNELS_1_1 = 0x2 << 0,
+               FEATURE_VIDEOCHANNELS_2 = 0x3 << 0,
+       };
+
+       enum {
+               EXT_FEATURE_OSD = BIT(15),
+               EXT_FEATURE_ETHERNET = BIT(9),
+               EXT_FEATURE_INTERLACE = BIT(8),
+               EXT_FEATURE_RS232 = BIT(7),
+               EXT_FEATURE_COMPRESSION_PERF_MASK = GENMASK(6, 4),
+               EXT_FEATURE_COMPRESSION_PERF_1X = 0x0 << 4,
+               EXT_FEATURE_COMPRESSION_PERF_2X = 0x1 << 4,
+               EXT_FEATURE_COMPRESSION_PERF_4X = 0x2 << 4,
+               EXT_FEATURE_COMPRESSION_TYPE1 = BIT(0),
+               EXT_FEATURE_COMPRESSION_TYPE2 = BIT(1),
+               EXT_FEATURE_COMPRESSION_TYPE3 = BIT(2),
+       };
+
+       u16 raw_features;
+       u16 raw_extended_features;
+
+       memset(features, 0, sizeof(struct fpga_features));
+
+       ihs_fpga_get(priv->map, features, &raw_features);
+       ihs_fpga_get(priv->map, extended_features, &raw_extended_features);
+
+       switch (raw_features & FEATURE_VIDEOCHANNELS_MASK) {
+       case FEATURE_VIDEOCHANNELS_0:
+               features->video_channels = 0;
+               break;
+
+       case FEATURE_VIDEOCHANNELS_1:
+               features->video_channels = 1;
+               break;
+
+       case FEATURE_VIDEOCHANNELS_1_1:
+       case FEATURE_VIDEOCHANNELS_2:
+               features->video_channels = 2;
+               break;
+       };
+
+       switch (raw_features & FEATURE_CARRIERS_MASK) {
+       case FEATURE_CARRIERS_0:
+               features->carriers = 0;
+               break;
+
+       case FEATURE_CARRIERS_1:
+               features->carriers = 1;
+               break;
+
+       case FEATURE_CARRIERS_2:
+               features->carriers = 2;
+               break;
+
+       case FEATURE_CARRIERS_4:
+               features->carriers = 4;
+               break;
+       }
+
+       switch (raw_features & FEATURE_CARRIER_SPEED_MASK) {
+       case FEATURE_CARRIER_SPEED_1G:
+               features->carrier_speed = CARRIER_SPEED_1G;
+               break;
+       case FEATURE_CARRIER_SPEED_2_5G:
+               features->carrier_speed = CARRIER_SPEED_2_5G;
+               break;
+       case FEATURE_CARRIER_SPEED_10G:
+               features->carrier_speed = CARRIER_SPEED_10G;
+               break;
+       }
+
+       switch (raw_features & FEATURE_RAM_MASK) {
+       case FEATURE_RAM_DDR2_32BIT_295MBPS:
+               features->ram_config = RAM_DDR2_32BIT_295MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_32BIT_590MBPS:
+               features->ram_config = RAM_DDR3_32BIT_590MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_48BIT_590MBPS:
+               features->ram_config = RAM_DDR3_48BIT_590MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_64BIT_1800MBPS:
+               features->ram_config = RAM_DDR3_64BIT_1800MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_48BIT_1800MBPS:
+               features->ram_config = RAM_DDR3_48BIT_1800MBPS;
+               break;
+       }
+
+       features->pcm_tx = raw_features & FEATURE_PCM_TX;
+       features->pcm_rx = raw_features & FEATURE_PCM_RX;
+       features->spdif_tx = raw_features & FEATURE_SPDIF_TX;
+       features->spdif_rx = raw_features & FEATURE_SPDIF_RX;
+       features->usb2 = raw_features & FEATURE_USB2;
+       features->rs232 = raw_extended_features & EXT_FEATURE_RS232;
+       features->compression_type1 = raw_extended_features &
+                                       EXT_FEATURE_COMPRESSION_TYPE1;
+       features->compression_type2 = raw_extended_features &
+                                       EXT_FEATURE_COMPRESSION_TYPE2;
+       features->compression_type3 = raw_extended_features &
+                                       EXT_FEATURE_COMPRESSION_TYPE3;
+       features->interlace = raw_extended_features & EXT_FEATURE_INTERLACE;
+       features->osd = raw_extended_features & EXT_FEATURE_OSD;
+       features->compression_pipes = raw_extended_features &
+                                       EXT_FEATURE_COMPRESSION_PERF_MASK;
+
+       return 0;
+}
+
+#else
+
+/**
+ * get_versions() - Fill structure with info from version register.
+ * @fpga:     Identifier of the FPGA device to be queried for information
+ * @versions: Pointer to the structure to fill with information from the
+ *           versions register
+ *
+ * This is the legacy version and should be considered deprecated for new
+ * devices.
+ *
+ * Return: 0
+ */
+static int get_versions(unsigned int fpga, struct fpga_versions *versions)
+{
+       enum {
+               /* HW version encoding is a mess, leave it for the moment */
+               VERSIONS_HW_VER_MASK = 0xf << 0,
+               VERSIONS_PIX_CLOCK_GEN_IDT8N3QV01 = BIT(4),
+               VERSIONS_SFP = BIT(5),
+               VERSIONS_VIDEO_MASK = 0x7 << 6,
+               VERSIONS_VIDEO_DVI = 0x0 << 6,
+               VERSIONS_VIDEO_DP_165 = 0x1 << 6,
+               VERSIONS_VIDEO_DP_300 = 0x2 << 6,
+               VERSIONS_VIDEO_HDMI = 0x3 << 6,
+               VERSIONS_UT_MASK = 0xf << 12,
+               VERSIONS_UT_MAIN_SERVER = 0x0 << 12,
+               VERSIONS_UT_MAIN_USER = 0x1 << 12,
+               VERSIONS_UT_VIDEO_SERVER = 0x2 << 12,
+               VERSIONS_UT_VIDEO_USER = 0x3 << 12,
+       };
+       u16 raw_versions;
+
+       memset(versions, 0, sizeof(struct fpga_versions));
+
+       FPGA_GET_REG(fpga, versions, &raw_versions);
+
+       switch (raw_versions & VERSIONS_UT_MASK) {
+       case VERSIONS_UT_MAIN_SERVER:
+               versions->video_channel = false;
+               versions->con_side = false;
+               break;
+
+       case VERSIONS_UT_MAIN_USER:
+               versions->video_channel = false;
+               versions->con_side = true;
+               break;
+
+       case VERSIONS_UT_VIDEO_SERVER:
+               versions->video_channel = true;
+               versions->con_side = false;
+               break;
+
+       case VERSIONS_UT_VIDEO_USER:
+               versions->video_channel = true;
+               versions->con_side = true;
+               break;
+       }
+
+       switch (raw_versions & VERSIONS_VIDEO_MASK) {
+       case VERSIONS_VIDEO_DVI:
+               versions->pcb_video_type = PCB_DVI_SL;
+               break;
+
+       case VERSIONS_VIDEO_DP_165:
+               versions->pcb_video_type = PCB_DP_165MPIX;
+               break;
+
+       case VERSIONS_VIDEO_DP_300:
+               versions->pcb_video_type = PCB_DP_300MPIX;
+               break;
+
+       case VERSIONS_VIDEO_HDMI:
+               versions->pcb_video_type = PCB_HDMI;
+               break;
+       }
+
+       versions->hw_version = raw_versions & VERSIONS_HW_VER_MASK;
+
+       if (raw_versions & VERSIONS_SFP)
+               versions->pcb_transmission_type = PCB_FIBER_3G;
+       else
+               versions->pcb_transmission_type = PCB_CAT_1G;
+
+       return 0;
+}
+
+/**
+ * get_features() - Fill structure with info from features register.
+ * @fpga:     Identifier of the FPGA device to be queried for information
+ * @features: Pointer to the structure to fill with information from the
+ *           features register
+ *
+ * This is the legacy version and should be considered deprecated for new
+ * devices.
+ *
+ * Return: 0
+ */
+static int get_features(unsigned int fpga, struct fpga_features *features)
+{
+       enum {
+               FEATURE_CARRIER_SPEED_2_5 = BIT(4),
+               FEATURE_RAM_MASK = 0x7 << 5,
+               FEATURE_RAM_DDR2_32BIT = 0x0 << 5,
+               FEATURE_RAM_DDR3_32BIT = 0x1 << 5,
+               FEATURE_RAM_DDR3_48BIT = 0x2 << 5,
+               FEATURE_PCM_AUDIO_TX = BIT(9),
+               FEATURE_PCM_AUDIO_RX = BIT(10),
+               FEATURE_OSD = BIT(11),
+               FEATURE_USB20 = BIT(12),
+               FEATURE_COMPRESSION_MASK = 7 << 13,
+               FEATURE_COMPRESSION_TYPE1 = 0x1 << 13,
+               FEATURE_COMPRESSION_TYPE1_TYPE2 = 0x3 << 13,
+               FEATURE_COMPRESSION_TYPE1_TYPE2_TYPE3 = 0x7 << 13,
+       };
+
+       enum {
+               EXTENDED_FEATURE_SPDIF_AUDIO_TX = BIT(0),
+               EXTENDED_FEATURE_SPDIF_AUDIO_RX = BIT(1),
+               EXTENDED_FEATURE_RS232 = BIT(2),
+               EXTENDED_FEATURE_COMPRESSION_PIPES = BIT(3),
+               EXTENDED_FEATURE_INTERLACE = BIT(4),
+       };
+
+       u16 raw_features;
+       u16 raw_extended_features;
+
+       memset(features, 0, sizeof(struct fpga_features));
+
+       FPGA_GET_REG(fpga, fpga_features, &raw_features);
+       FPGA_GET_REG(fpga, fpga_ext_features, &raw_extended_features);
+
+       features->video_channels = raw_features & 0x3;
+       features->carriers = (raw_features >> 2) & 0x3;
+
+       features->carrier_speed = (raw_features & FEATURE_CARRIER_SPEED_2_5)
+               ? CARRIER_SPEED_2_5G : CARRIER_SPEED_1G;
+
+       switch (raw_features & FEATURE_RAM_MASK) {
+       case FEATURE_RAM_DDR2_32BIT:
+               features->ram_config = RAM_DDR2_32BIT_295MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_32BIT:
+               features->ram_config = RAM_DDR3_32BIT_590MBPS;
+               break;
+
+       case FEATURE_RAM_DDR3_48BIT:
+               features->ram_config = RAM_DDR3_48BIT_590MBPS;
+               break;
+       }
+
+       features->pcm_tx = raw_features & FEATURE_PCM_AUDIO_TX;
+       features->pcm_rx = raw_features & FEATURE_PCM_AUDIO_RX;
+       features->spdif_tx = raw_extended_features &
+                               EXTENDED_FEATURE_SPDIF_AUDIO_TX;
+       features->spdif_rx = raw_extended_features &
+                               EXTENDED_FEATURE_SPDIF_AUDIO_RX;
+
+       features->usb2 = raw_features & FEATURE_USB20;
+       features->rs232 = raw_extended_features & EXTENDED_FEATURE_RS232;
+
+       features->compression_type1 = false;
+       features->compression_type2 = false;
+       features->compression_type3 = false;
+       switch (raw_features & FEATURE_COMPRESSION_MASK) {
+       case FEATURE_COMPRESSION_TYPE1_TYPE2_TYPE3:
+               features->compression_type3 = true;
+               /* fall-through */
+       case FEATURE_COMPRESSION_TYPE1_TYPE2:
+               features->compression_type2 = true;
+               /* fall-through */
+       case FEATURE_COMPRESSION_TYPE1:
+               features->compression_type1 = true;
+               break;
+       }
+
+       features->interlace = raw_extended_features &
+                               EXTENDED_FEATURE_INTERLACE;
+       features->osd = raw_features & FEATURE_OSD;
+       features->compression_pipes = raw_extended_features &
+                                       EXTENDED_FEATURE_COMPRESSION_PIPES;
+
+       return 0;
+}
+
+#endif
+
+/**
+ * fpga_print_info() - Print information about FPGA device
+ * @dev: FPGA device to print information about
+ */
+static void fpga_print_info(struct udevice *dev)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       u16 fpga_version;
+       struct fpga_versions versions;
+       struct fpga_features features;
+
+       ihs_fpga_get(priv->map, fpga_version, &fpga_version);
+       get_versions(dev, &versions);
+       get_features(dev, &features);
+
+       if (versions.video_channel)
+               printf("Videochannel");
+       else
+               printf("Mainchannel");
+
+       if (versions.con_side)
+               printf(" User");
+       else
+               printf(" Server");
+
+       switch (versions.pcb_transmission_type) {
+       case PCB_CAT_1G:
+       case PCB_CAT_10G:
+               printf(" CAT");
+               break;
+       case PCB_FIBER_3G:
+       case PCB_FIBER_10G:
+               printf(" Fiber");
+               break;
+       };
+
+       switch (versions.pcb_video_type) {
+       case PCB_DVI_SL:
+               printf(" DVI,");
+               break;
+       case PCB_DP_165MPIX:
+               printf(" DP 165MPix/s,");
+               break;
+       case PCB_DP_300MPIX:
+               printf(" DP 300MPix/s,");
+               break;
+       case PCB_HDMI:
+               printf(" HDMI,");
+               break;
+       case PCB_DP_1_2:
+               printf(" DP 1.2,");
+               break;
+       case PCB_HDMI_2_0:
+               printf(" HDMI 2.0,");
+               break;
+       }
+
+       printf(" FPGA V %d.%02d\n       features: ",
+              fpga_version / 100, fpga_version % 100);
+
+       if (!features.compression_type1 &&
+           !features.compression_type2 &&
+           !features.compression_type3)
+               printf("no compression, ");
+
+       if (features.compression_type1)
+               printf("type1, ");
+
+       if (features.compression_type2)
+               printf("type2, ");
+
+       if (features.compression_type3)
+               printf("type3, ");
+
+       printf("%sosd", features.osd ? "" : "no ");
+
+       if (features.pcm_rx && features.pcm_tx)
+               printf(", pcm rx+tx");
+       else if (features.pcm_rx)
+               printf(", pcm rx");
+       else if (features.pcm_tx)
+               printf(", pcm tx");
+
+       if (features.spdif_rx && features.spdif_tx)
+               printf(", spdif rx+tx");
+       else if (features.spdif_rx)
+               printf(", spdif rx");
+       else if (features.spdif_tx)
+               printf(", spdif tx");
+
+       puts(",\n       ");
+
+       switch (features.sysclock) {
+       case SYSCLK_147456:
+               printf("clock 147.456 MHz");
+               break;
+       }
+
+       switch (features.ram_config) {
+       case RAM_DDR2_32BIT_295MBPS:
+               printf(", RAM 32 bit DDR2");
+               break;
+       case RAM_DDR3_32BIT_590MBPS:
+               printf(", RAM 32 bit DDR3");
+               break;
+       case RAM_DDR3_48BIT_590MBPS:
+       case RAM_DDR3_48BIT_1800MBPS:
+               printf(", RAM 48 bit DDR3");
+               break;
+       case RAM_DDR3_64BIT_1800MBPS:
+               printf(", RAM 64 bit DDR3");
+               break;
+       }
+
+       printf(", %d carrier(s)", features.carriers);
+
+       switch (features.carrier_speed) {
+       case CARRIER_SPEED_1G:
+               printf(", 1Gbit/s");
+               break;
+       case CARRIER_SPEED_3G:
+               printf(", 3Gbit/s");
+               break;
+       case CARRIER_SPEED_10G:
+               printf(", 10Gbit/s");
+               break;
+       }
+
+       printf(", %d video channel(s)\n", features.video_channels);
+}
+
+/**
+ * do_reflection_test() - Run reflection test on a FPGA device
+ * @dev: FPGA device to run reflection test on
+ *
+ * Return: 0 if reflection test succeeded, -ve on error
+ */
+static int do_reflection_test(struct udevice *dev)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       int ctr = 0;
+
+       while (1) {
+               u16 val;
+
+               ihs_fpga_set(priv->map, reflection_low, REFLECTION_TESTPATTERN);
+
+               ihs_fpga_get(priv->map, reflection_low, &val);
+               if (val == (~REFLECTION_TESTPATTERN & 0xffff))
+                       return -EIO;
+
+               mdelay(REFLECTION_TEST_DELAY);
+               if (ctr++ > REFLECTION_TEST_ROUNDS)
+                       return 0;
+       }
+}
+
+/**
+ * wait_for_fpga_done() - Wait until 'done'-flag is set for FPGA device
+ * @dev: FPGA device whose done flag to wait for
+ *
+ * This function waits until it detects that the done-GPIO's value was changed
+ * to 1 by the FPGA, which indicates that the device is configured and ready to
+ * use.
+ *
+ * Return: 0 if done flag was detected, -ve on error
+ */
+static int wait_for_fpga_done(struct udevice *dev)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       int ctr = 0;
+       int done_val;
+
+       while (1) {
+               done_val = dm_gpio_get_value(&priv->done_gpio);
+               if (done_val < 0) {
+                       debug("%s: Error while reading done-GPIO (err = %d)\n",
+                             dev->name, done_val);
+                       return done_val;
+               }
+
+               if (done_val)
+                       return 0;
+
+               mdelay(FPGA_DONE_WAIT_DELAY);
+               if (ctr++ > FPGA_DONE_WAIT_ROUND) {
+                       debug("%s: FPGA init failed (done not detected)\n",
+                             dev->name);
+                       return -EIO;
+               }
+       }
+}
+
+static int ihs_fpga_probe(struct udevice *dev)
+{
+       struct ihs_fpga_priv *priv = dev_get_priv(dev);
+       int ret;
+
+       /* TODO(mario.six@gdsys.cc): Case of FPGA attached to MCLink bus */
+
+       ret = regmap_init_mem(dev_ofnode(dev), &priv->map);
+       if (ret) {
+               debug("%s: Could not initialize regmap (err = %d)",
+                     dev->name, ret);
+               return ret;
+       }
+
+       ret = gpio_request_by_name(dev, "reset-gpios", 0, &priv->reset_gpio,
+                                  GPIOD_IS_OUT);
+       if (ret) {
+               debug("%s: Could not get reset-GPIO (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       if (!priv->reset_gpio.dev) {
+               debug("%s: Could not get reset-GPIO\n", dev->name);
+               return -ENOENT;
+       }
+
+       ret = gpio_request_by_name(dev, "done-gpios", 0, &priv->done_gpio,
+                                  GPIOD_IS_IN);
+       if (ret) {
+               debug("%s: Could not get done-GPIO (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       if (!priv->done_gpio.dev) {
+               debug("%s: Could not get done-GPIO\n", dev->name);
+               return -ENOENT;
+       }
+
+       ret = dm_gpio_set_value(&priv->reset_gpio, 1);
+       if (ret) {
+               debug("%s: Error while setting reset-GPIO (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       /* If FPGA already runs, don't initialize again */
+       if (do_reflection_test(dev))
+               goto reflection_ok;
+
+       ret = dm_gpio_set_value(&priv->reset_gpio, 0);
+       if (ret) {
+               debug("%s: Error while setting reset-GPIO (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       ret = wait_for_fpga_done(dev);
+       if (ret) {
+               debug("%s: Error while waiting for FPGA done (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       udelay(10);
+
+       ret = dm_gpio_set_value(&priv->reset_gpio, 1);
+       if (ret) {
+               debug("%s: Error while setting reset-GPIO (err = %d)\n",
+                     dev->name, ret);
+               return ret;
+       }
+
+       if (!do_reflection_test(dev)) {
+               debug("%s: Reflection test FAILED\n", dev->name);
+               return -EIO;
+       }
+
+reflection_ok:
+       printf("%s: Reflection test passed.\n", dev->name);
+
+       fpga_print_info(dev);
+
+       return 0;
+}
+
+static const struct udevice_id ihs_fpga_ids[] = {
+       { .compatible = "gdsys,iocon_fpga" },
+       { .compatible = "gdsys,iocpu_fpga" },
+       { }
+};
+
+U_BOOT_DRIVER(ihs_fpga_bus) = {
+       .name           = "ihs_fpga_bus",
+       .id             = UCLASS_MISC,
+       .of_match       = ihs_fpga_ids,
+       .probe          = ihs_fpga_probe,
+       .priv_auto_alloc_size = sizeof(struct ihs_fpga_priv),
+};
diff --git a/drivers/misc/ihs_fpga.h b/drivers/misc/ihs_fpga.h
new file mode 100644 (file)
index 0000000..efb5dab
--- /dev/null
@@ -0,0 +1,49 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * (C) Copyright 2018
+ * Mario Six, Guntermann & Drunck GmbH, mario.six@gdsys.cc
+ */
+
+/**
+ * struct ihs_fpga_regs - IHS FPGA register map structure
+ * @reflection_low:      Lower reflection register
+ * @versions:            PCB versions register
+ * @fpga_version:        FPGA versions register
+ * @features:            FPGA features register
+ * @extended_features:   FPGA extended features register
+ * @top_interrupt:       Top interrupt register
+ * @top_interrupt_enable: Top interrupt enable register
+ * @status:              FPGA status register
+ * @control:             FPGA control register
+ * @extended_control:    FPGA extended control register
+ */
+struct ihs_fpga_regs {
+       u16 reflection_low;
+       u16 versions;
+       u16 fpga_version;
+       u16 features;
+       u16 extended_features;
+       u16 top_interrupt;
+       u16 top_interrupt_enable;
+       u16 status;
+       u16 control;
+       u16 extended_control;
+};
+
+/**
+ * ihs_fpga_set() - Convenience macro to set values in FPGA register map
+ * @map:    Register map to set a value in
+ * @member: Name of member (described by ihs_fpga_regs) to set
+ * @val:    Value to set the member to
+ */
+#define ihs_fpga_set(map, member, val) \
+       regmap_set(map, struct ihs_fpga_regs, member, val)
+
+/**
+ * ihs_fpga_get() - Convenience macro to get values from FPGA register map
+ * @map:    Register map to read value from
+ * @member: Name of member (described by ihs_fpga_regs) to get
+ * @valp:   Pointe to variable to receive the value read
+ */
+#define ihs_fpga_get(map, member, valp) \
+       regmap_get(map, struct ihs_fpga_regs, member, valp)