Skip to contentSkip to conversation

mfd: lochnagar: Add initial binding documentation

PATCH Superseded Charles Keepax 5 participants 16 messages Oct 19, 2018 – Oct 30, 2018

Subsystems (8)

v3 of 8 Superseded Latest is v8 →

lore
Share & tools
lore

Charles Keepax

author maintainer
#0 lore raw

PATCH v3 1/5 mfd: lochnagar: Add initial binding documentation

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

---

Changes since v2:
- Used vendor prefix on aif-master and aif-slave
- Used -gpios instead of -gpio in example DT
- Used - rather than _ on node names in example DT
- Removed some clocks from the clock DT binding doc since they are now being registered purely through DT as fixed clocks

Thanks,
Charles

 .../devicetree/bindings/mfd/cirrus,lochnagar.txt   | 230 +++++++++++++++++++++
 include/dt-bindings/clk/lochnagar.h                |  26 +++
 include/dt-bindings/pinctrl/lochnagar.h            | 132 ++++++++++++
 3 files changed, 388 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt
 create mode 100644 include/dt-bindings/clk/lochnagar.h
 create mode 100644 include/dt-bindings/pinctrl/lochnagar.h
Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt new file +230 -0
new file mode 100644
index 0000000000000..4bed850aa7101
@@ -0,0 +1,230 @@
+Cirrus Logic Lochnagar Audio Development Board
+
+Lochnagar is an evaluation and development board for Cirrus Logic
+Smart CODEC and Amp devices. It allows the connection of most Cirrus
+Logic devices on mini-cards, as well as allowing connection of
+various application processor systems to provide a full evaluation
+platform.  Audio system topology, clocking and power can all be
+controlled through the Lochnagar, allowing the device under test
+to be used in a variety of possible use cases.
+
+Also see these documents for generic binding information:
+  [1] GPIO : ../gpio/gpio.txt
+  [2] Pinctrl: ../pinctrl/pinctrl-bindings.txt
+  [3] Clock : ../clock/clock-bindings.txt
+  [4] Regulator: ../regulator/regulator.txt
+
+And these for relevant defines:
+  [5] include/dt-bindings/pinctrl/lochnagar.h
+  [6] include/dt-bindings/clock/lochnagar.h
+
+Required properties:
+
+  - compatible : One of the following strings:
+                 "cirrus,lochnagar1"
+                 "cirrus,lochnagar2"
+
+  - reg : I2C slave address
+
+  - gpio-controller : Indicates this device is a GPIO controller.
+  - #gpio-cells : Must be 2. The first cell is the pin number, see
+    [5] for available pins and the second cell is used to specify
+    optional parameters, see [1].
+  - gpio-ranges : Range of pins managed by the GPIO controller, see
+    [1]. Both the GPIO and Pinctrl base should be set to zero and the
+    count to the appropriate of the LOCHNAGARx_PIN_NUM_GPIOS define,
+    see [5].
+
+  - reset-gpios : Reset line to the Lochnagar, see [1].
+
+  - #clock-cells : Must be 1. The first cell indicates the clock
+    number, see [6] for available clocks and [3].
+
+  - pinctrl-names : A pinctrl state named "default" must be defined.
+  - pinctrl-0 : A phandle to the default pinctrl state.
+
+  - SYSVDD-supply: Primary power supply for the Lochnagar.
+
+Optional properties:
+
+  - present-gpios : Host present line, indicating the presence of a
+    host system, see [1]. This can be omitted if the present line is
+    tied in hardware.
+
+  - clocks : Must contain an entry for each clock in clock-names.
+  - clock-names : May contain entries for each of the following
+    clocks:
+     - ln-cdc-clkout : Output clock from CODEC card.
+     - ln-dsp-clkout : Output clock from DSP card.
+     - ln-gf-mclk1,ln-gf-mclk2,ln-gf-mclk3,ln-gf-mclk4 : Optional
+       input audio clocks from host system.
+     - ln-psia1-mclk, ln-psia2-mclk : Optional input audio clocks from
+       external connector.
+     - ln-spdif-clkout : Optional input audio clock from SPDIF.
+     - ln-adat-clkout : Optional input audio clock from ADAT.
+
+  - assigned-clocks : A list of Lochnagar clocks to be reparented, see
+    [6] for available clocks.
+  - assigned-clock-parents : Parents to be assigned to the clocks
+    listed in "assigned-clocks".
+
+  - MICBIAS1-supply, MICBIAS2-supply: Regulator supplies for the
+    MICxVDD outputs, supplying the digital microphones, normally
+    supplied from the attached CODEC.
+
+Required sub-nodes:
+
+The pin configurations are defined as a child of the pinctrl states
+node, see [2]. Each sub-node can have the following properties:
+  - groups : A list of groups to select (either this or "pins" must be
+    specified), available groups:
+      codec-aif1, codec-aif2, codec-aif3, dsp-aif1, dsp-aif2, psia1,
+      psia2, gf-aif1, gf-aif2, gf-aif3, gf-aif4, spdif-aif, usb-aif1,
+      usb-aif2, adat-aif, soundcard-aif
+  - pins : A list of pin names to select (either this or "groups" must
+    be specified), available pins:
+      fgpa-gpio1, fgpa-gpio2, fgpa-gpio3, fgpa-gpio4, fgpa-gpio5,
+      fgpa-gpio6, codec-gpio1, codec-gpio2, codec-gpio3, codec-gpio4,
+      codec-gpio5, codec-gpio6, codec-gpio7, codec-gpio8, dsp-gpio1,
+      dsp-gpio2, dsp-gpio3, dsp-gpio4, dsp-gpio5, dsp-gpio6, gf-gpio2,
+      gf-gpio3, gf-gpio7, codec-aif1-bclk, codec-aif1-rxdat,
+      codec-aif1-lrclk, codec-aif1-txdat, codec-aif2-bclk,
+      codec-aif2-rxdat, codec-aif2-lrclk, codec-aif2-txdat,
+      codec-aif3-bclk, codec-aif3-rxdat, codec-aif3-lrclk,
+      codec-aif3-txdat, dsp-aif1-bclk, dsp-aif1-rxdat, dsp-aif1-lrclk,
+      dsp-aif1-txdat, dsp-aif2-bclk, dsp-aif2-rxdat,
+      dsp-aif2-lrclk, dsp-aif2-txdat, psia1-bclk, psia1-rxdat,
+      psia1-lrclk, psia1-txdat, psia2-bclk, psia2-rxdat, psia2-lrclk,
+      psia2-txdat, gf-aif3-bclk, gf-aif3-rxdat, gf-aif3-lrclk,
+      gf-aif3-txdat, gf-aif4-bclk, gf-aif4-rxdat, gf-aif4-lrclk,
+      gf-aif4-txdat, gf-aif1-bclk, gf-aif1-rxdat, gf-aif1-lrclk,
+      gf-aif1-txdat, gf-aif2-bclk, gf-aif2-rxdat, gf-aif2-lrclk,
+      gf-aif2-txdat, dsp-uart1-rx, dsp-uart1-tx, dsp-uart2-rx,
+      dsp-uart2-tx, gf-uart2-rx, gf-uart2-tx, usb-uart-rx,
+      codec-pdmclk1, codec-pdmdat1, codec-pdmclk2, codec-pdmdat2,
+      codec-dmicclk1, codec-dmicdat1, codec-dmicclk2, codec-dmicdat2,
+      codec-dmicclk3, codec-dmicdat3, codec-dmicclk4, codec-dmicdat4,
+      dsp-dmicclk1, dsp-dmicdat1, dsp-dmicclk2, dsp-dmicdat2, i2c2-scl,
+      i2c2-sda, i2c3-scl, i2c3-sda, i2c4-scl, i2c4-sda, dsp-standby,
+      codec-mclk1, codec-mclk2, dsp-clkin, psia1-mclk, psia2-mclk,
+      gf-gpio1, gf-gpio5, dsp-gpio20, led1, led2
+  - function : The mux function to select, available functions:
+      aif, fgpa-gpio1, fgpa-gpio2, fgpa-gpio3, fgpa-gpio4, fgpa-gpio5,
+      fgpa-gpio6, codec-gpio1, codec-gpio2, codec-gpio3, codec-gpio4,
+      codec-gpio5, codec-gpio6, codec-gpio7, codec-gpio8, dsp-gpio1,
+      dsp-gpio2, dsp-gpio3, dsp-gpio4, dsp-gpio5, dsp-gpio6, gf-gpio2,
+      gf-gpio3, gf-gpio7, gf-gpio1, gf-gpio5, dsp-gpio20, codec-clkout,
+      dsp-clkout, pmic-32k, spdif-clkout, clk-12m288, clk-11m2986,
+      clk-24m576, clk-22m5792, xmos-mclk, gf-clkout1, gf-mclk1,
+      gf-mclk3, gf-mclk2, gf-clkout2, codec-mclk1, codec-mclk2,
+      dsp-clkin, psia1-mclk, psia2-mclk, spdif-mclk, codec-irq,
+      codec-reset, dsp-reset, dsp-irq, dsp-standby, codec-pdmclk1,
+      codec-pdmdat1, codec-pdmclk2, codec-pdmdat2, codec-dmicclk1,
+      codec-dmicdat1, codec-dmicclk2, codec-dmicdat2, codec-dmicclk3,
+      codec-dmicdat3, codec-dmicclk4, codec-dmicdat4, dsp-dmicclk1,
+      dsp-dmicdat1, dsp-dmicclk2, dsp-dmicdat2, dsp-uart1-rx,
+      dsp-uart1-tx, dsp-uart2-rx, dsp-uart2-tx, gf-uart2-rx,
+      gf-uart2-tx, usb-uart-rx, usb-uart-tx, i2c2-scl, i2c2-sda,
+      i2c3-scl, i2c3-sda, i2c4-scl, i2c4-sda, gpio, spdif-aif, psia1,
+      psia1-bclk, psia1-lrclk, psia1-rxdat, psia1-txdat, psia2,
+      psia2-bclk, psia2-lrclk, psia2-rxdat, psia2-txdat, codec-aif1,
+      codec-aif1-bclk, codec-aif1-lrclk, codec-aif1-rxdat,
+      codec-aif1-txdat, codec-aif2, codec-aif2-bclk, codec-aif2-lrclk,
+      codec-aif2-rxdat, codec-aif2-txdat, codec-aif3, codec-aif3-bclk,
+      codec-aif3-lrclk, codec-aif3-rxdat, codec-aif3-txdat, dsp-aif1,
+      dsp-aif1-bclk, dsp-aif1-lrclk, dsp-aif1-rxdat, dsp-aif1-txdat,
+      dsp-aif2, dsp-aif2-bclk, dsp-aif2-lrclk, dsp-aif2-rxdat,
+      dsp-aif2-txdat, gf-aif3, gf-aif3-bclk, gf-aif3-lrclk,
+      gf-aif3-rxdat, gf-aif3-txdat, gf-aif4, gf-aif4-bclk,
+      gf-aif4-lrclk, gf-aif4-rxdat, gf-aif4-txdat, gf-aif1,
+      gf-aif1-bclk, gf-aif1-lrclk, gf-aif1-rxdat, gf-aif1-txdat,
+      gf-aif2, gf-aif2-bclk, gf-aif2-lrclk, gf-aif2-rxdat,
+      gf-aif2-txdat, usb-aif1, usb-aif2, adat-aif, soundcard-aif,
+
+  - aif-master : Specifies that an AIF group will be used as a master
+    interface (either this or aif-slave is required if a group is
+    being muxed to an AIF)
+  - aif-slave : Specifies that an AIF group will be used as a slave
+    interface (either this or aif-master is required if a group is
+    being muxed to an AIF)
+
+Optional sub-nodes:
+
+  - VDDCORE : Initialisation data for the VDDCORE regulator, which
+    supplies the CODECs digital core if it has no build regulator for that
+    purpose.
+
+  - MICVDD : Initialisation data for the MICVDD regulator, which
+    supplies the CODECs MICVDD.
+  - MIC1VDD, MIC2VDD : Initialisation data for the MICxVDD supplies.
+      Optional Properties:
+      - cirrus,micbias-input : A property selecting which of the CODEC
+        minicard micbias outputs should be used, valid values are 1 - 4.
+
+  - VDD1V8 : Recommended fixed regulator for the VDD1V8 regulator, which supplies the
+    CODECs analog and 1.8V digital supplies.
+      Required Properties:
+      - compatible : Should be set to "regulator-fixed"
+      - regulator-min-microvolt : Should be set to 1.8V
+      - regulator-max-microvolt : Should be set to 1.8V
+      - regulator-boot-on
+      - regulator-always-on
+      - vin-supply : Should be set to same supply as SYSVDD
+
+Example:
+lochnagar: lochnagar@22 {
+	compatible = "cirrus,lochnagar2";
+	reg = <0x22>;
+
+	gpio-controller;
+	#gpio-cells = <2>;
+	gpio-ranges = <&lochnagar 0 0 110>;
+
+	reset-gpios = <&gpio0 55 0>;
+	present-gpios = <&gpio0 60 0>;
+
+	#clock-cells = <1>;
+
+	clocks = <&clk-audio>;
+	clock-names = "ln-gf-mclk2";
+
+	assigned-clocks = <&lochnagar LOCHNAGAR_CDC_MCLK1>,
+			  <&lochnagar LOCHNAGAR_CDC_MCLK2>;
+	assigned-clock-parents = <&clk-audio>,
+				 <&lochnagar LOCHNAGAR_PMIC_32K>;
+
+	SYSVDD-supply = <&wallvdd>;
+
+	pinctrl-names = "default";
+	pinctrl-0 = <&pin-settings>;
+
+	pin-settings: pin-settings {
+		ap-aif {
+			aif-slave;
+			groups = "gf-aif1";
+			function = "codec-aif3";
+		};
+		codec-aif {
+			aif-master;
+			groups = "codec-aif3";
+			function = "gf-aif1";
+		};
+	};
+
+	lochnagar-micvdd: MICVDD {
+		regulator-min-microvolt = <3300000>;
+		regulator-max-microvolt = <3300000>;
+	};
+
+	lochnagar-vdd1v8: VDD1V8 {
+		compatible = "regulator-fixed";
+
+		regulator-name = "VDD1V8";
+		regulator-min-microvolt = <1800000>;
+		regulator-max-microvolt = <1800000>;
+		regulator-boot-on;
+		regulator-always-on;
+
+		vin-supply = <&wallvdd>;
+	};
+};
include/dt-bindings/clk/lochnagar.h new file +26 -0
new file mode 100644
index 0000000000000..8fa20551ff171
@@ -0,0 +1,26 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Device Tree defines for Lochnagar clocking
+ *
+ * Copyright (c) 2017-2018 Cirrus Logic, Inc. and
+ *                         Cirrus Logic International Semiconductor Ltd.
+ *
+ * Author: Charles Keepax <[email protected]>
+ */
+
+#ifndef DT_BINDINGS_CLK_LOCHNAGAR_H
+#define DT_BINDINGS_CLK_LOCHNAGAR_H
+
+#define LOCHNAGAR_CDC_MCLK1		0
+#define LOCHNAGAR_CDC_MCLK2		1
+#define LOCHNAGAR_DSP_CLKIN		2
+#define LOCHNAGAR_GF_CLKOUT1		3
+#define LOCHNAGAR_GF_CLKOUT2		4
+#define LOCHNAGAR_PSIA1_MCLK		5
+#define LOCHNAGAR_PSIA2_MCLK		6
+#define LOCHNAGAR_SPDIF_MCLK		7
+#define LOCHNAGAR_ADAT_MCLK		8
+#define LOCHNAGAR_SOUNDCARD_MCLK	9
+#define LOCHNAGAR_SPDIF_CLKOUT		10
+
+#endif
include/dt-bindings/pinctrl/lochnagar.h new file +132 -0

132 lines not on this page · raw message

Signature · 1 line
2.11.0
author maintainer
#1 lore raw

PATCH v3 2/5 mfd: lochnagar: Add support for the Cirrus Logic Lochnagar

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board. Audio system topology, clocking and power can all be controlled through the Lochnagar controller chip, allowing the device under test to be used in a variety of possible use cases.

As the Lochnagar is a fairly complex device this MFD driver allows the drivers for the various features to be bound in. Initially clocking, regulator and pinctrl will be added as these are necessary to configure the system. But in time at least audio and voltage/current monitoring will also be added.

---

Changes since v2:
- Minor updates to the device names bound in for the clock driver

Thanks,
Charles

 MAINTAINERS                         |  13 +
 drivers/mfd/Kconfig                 |   8 +
 drivers/mfd/Makefile                |   2 +
 drivers/mfd/lochnagar-i2c.c         | 732 ++++++++++++++++++++++++++++++++++++
 include/linux/mfd/lochnagar.h       |  48 +++
 include/linux/mfd/lochnagar1_regs.h | 157 ++++++++
 include/linux/mfd/lochnagar2_regs.h | 253 +++++++++++++
 7 files changed, 1213 insertions(+)
 create mode 100644 drivers/mfd/lochnagar-i2c.c
 create mode 100644 include/linux/mfd/lochnagar.h
 create mode 100644 include/linux/mfd/lochnagar1_regs.h
 create mode 100644 include/linux/mfd/lochnagar2_regs.h
MAINTAINERS +13 -0
index d9e6d86488df4..f1f3494ac5cd8 100644
@@ -3557,6 +3557,19 @@ L:	[email protected]
 S:	Maintained
 F:	drivers/net/ethernet/cirrus/ep93xx_eth.c
 
+CIRRUS LOGIC LOCHNAGAR DRIVER
+M:	Charles Keepax <[email protected]>
+M:	Richard Fitzgerald <[email protected]>
+L:	[email protected]
+S:	Supported
+F:	drivers/clk/clk-lochnagar.c
+F:	drivers/mfd/lochnagar-i2c.c
+F:	drivers/pinctrl/cirrus/pinctrl-lochnagar.c
+F:	drivers/regulator/lochnagar-regulator.c
+F:	include/dt-bindings/clk/lochnagar.h
+F:	include/dt-bindings/pinctrl/lochnagar.h
+F:	include/linux/mfd/lochnagar*
+
 CISCO FCOE HBA DRIVER
 M:	Satish Kharat <[email protected]>
 M:	Sesidhar Baddela <[email protected]>
drivers/mfd/Kconfig +8 -0
index f3a5f8d027906..dc64151373714 100644
@@ -1676,6 +1676,14 @@ config MFD_VX855
 	  VIA VX855/VX875 south bridge. You will need to enable the vx855_spi
 	  and/or vx855_gpio drivers for this to do anything useful.
 
+config MFD_LOCHNAGAR
+	bool "Cirrus Logic Lochnagar Audio Development Board"
+	select MFD_CORE
+	select REGMAP_I2C
+	depends on I2C=y && OF
+	help
+	  Support for Cirrus Logic Lochnagar audio development board.
+
 config MFD_ARIZONA
 	select REGMAP
 	select REGMAP_IRQ
drivers/mfd/Makefile +2 -0
index 5856a9489cbd8..f16773cb887ff 100644
@@ -37,6 +37,8 @@ obj-$(CONFIG_MFD_T7L66XB)	+= t7l66xb.o tmio_core.o
 obj-$(CONFIG_MFD_TC6387XB)	+= tc6387xb.o tmio_core.o
 obj-$(CONFIG_MFD_TC6393XB)	+= tc6393xb.o tmio_core.o
 
+obj-$(CONFIG_MFD_LOCHNAGAR)	+= lochnagar-i2c.o
+
 obj-$(CONFIG_MFD_ARIZONA)	+= arizona-core.o
 obj-$(CONFIG_MFD_ARIZONA)	+= arizona-irq.o
 obj-$(CONFIG_MFD_ARIZONA_I2C)	+= arizona-i2c.o
drivers/mfd/lochnagar-i2c.c new file +732 -0

732 lines not on this page · raw message

include/linux/mfd/lochnagar.h new file +48 -0

48 lines not on this page · raw message

include/linux/mfd/lochnagar1_regs.h new file +157 -0

157 lines not on this page · raw message

include/linux/mfd/lochnagar2_regs.h new file +253 -0

253 lines not on this page · raw message

Signature · 1 line
2.11.0
author maintainer
#2 lore raw

PATCH v3 3/5 clk: lochnagar: Add support for the Cirrus Logic Lochnagar

In reply to Charles Keepax

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

The Lochnagar can take several input clocks from the host system, provides several of its own clock sources, and provides extensive routing options for those clocks to be supplied to the attached CODEC/Amp device.

---

Changes since v2:
- Remove some unused headers
- Remove an unused check on ena_mask
- Return an out of range value if get_parent fails
- Move to the hw based clock APIs
- Use u16s for register definitions
- Move fixed clocks into DT completely
- Don't use the Lochnagar struct directly

Note that the patch will still need to go through with the MFD stuff to build correctly.

Thanks,
Charles

 drivers/clk/Kconfig         |   7 +
 drivers/clk/Makefile        |   1 +
 drivers/clk/clk-lochnagar.c | 368 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 376 insertions(+)
 create mode 100644 drivers/clk/clk-lochnagar.c
drivers/clk/Kconfig +7 -0
index 292056bbb30e9..9247c97f85d79 100644
@@ -219,6 +219,13 @@ config COMMON_CLK_XGENE
 	---help---
 	  Sypport for the APM X-Gene SoC reference, PLL, and device clocks.
 
+config COMMON_CLK_LOCHNAGAR
+	tristate "Cirrus Logic Lochnagar clock driver"
+	depends on MFD_LOCHNAGAR
+	help
+	  This driver supports the clocking features of the Cirrus Logic
+	  Lochnagar audio development board.
+
 config COMMON_CLK_NXP
 	def_bool COMMON_CLK && (ARCH_LPC18XX || ARCH_LPC32XX)
 	select REGMAP_MMIO if ARCH_LPC32XX
drivers/clk/Makefile +1 -0
index a84c5573cabea..0443a7219bdf4 100644
@@ -30,6 +30,7 @@ obj-$(CONFIG_COMMON_CLK_GEMINI)		+= clk-gemini.o
 obj-$(CONFIG_COMMON_CLK_ASPEED)		+= clk-aspeed.o
 obj-$(CONFIG_ARCH_HIGHBANK)		+= clk-highbank.o
 obj-$(CONFIG_CLK_HSDK)			+= clk-hsdk-pll.o
+obj-$(CONFIG_COMMON_CLK_LOCHNAGAR)	+= clk-lochnagar.o
 obj-$(CONFIG_COMMON_CLK_MAX77686)	+= clk-max77686.o
 obj-$(CONFIG_COMMON_CLK_MAX9485)	+= clk-max9485.o
 obj-$(CONFIG_ARCH_MOXART)		+= clk-moxart.o
drivers/clk/clk-lochnagar.c new file +368 -0

368 lines not on this page · raw message

Signature · 1 line
2.11.0
author maintainer
#3 lore raw

PATCH v3 4/5 regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

In reply to Charles Keepax

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

The Lochnagar board provides power supplies for the attached CODEC/Amp device. Currently this driver supports the microphone supplies and the digital core voltage for the attached device. There are some additional supplies that will be added in time but these supplies are sufficient for most systems/use-cases.

---

No changes since v2.

Thanks,
Charles

 drivers/regulator/Kconfig               |   7 +
 drivers/regulator/Makefile              |   1 +
 drivers/regulator/lochnagar-regulator.c | 255 ++++++++++++++++++++++++++++++++
 3 files changed, 263 insertions(+)
 create mode 100644 drivers/regulator/lochnagar-regulator.c
drivers/regulator/Kconfig +7 -0
index 329cdd33ed624..3eda02afdcdeb 100644
@@ -356,6 +356,13 @@ config REGULATOR_LM363X
 	  One boost output voltage is configurable and always on.
 	  Other LDOs are used for the display module.
 
+config REGULATOR_LOCHNAGAR
+	tristate "Cirrus Logic Lochnagar regulator driver"
+	depends on MFD_LOCHNAGAR
+	help
+	  This enables regulator support on the Cirrus Logic Lochnagar audio
+	  development board.
+
 config REGULATOR_LP3971
 	tristate "National Semiconductors LP3971 PMIC regulator driver"
 	depends on I2C
drivers/regulator/Makefile +1 -0
index 801d9a34a2037..0c715fa77bd62 100644
@@ -46,6 +46,7 @@ obj-$(CONFIG_REGULATOR_HI655X) += hi655x-regulator.o
 obj-$(CONFIG_REGULATOR_ISL6271A) += isl6271a-regulator.o
 obj-$(CONFIG_REGULATOR_ISL9305) += isl9305.o
 obj-$(CONFIG_REGULATOR_LM363X) += lm363x-regulator.o
+obj-$(CONFIG_REGULATOR_LOCHNAGAR) += lochnagar-regulator.o
 obj-$(CONFIG_REGULATOR_LP3971) += lp3971.o
 obj-$(CONFIG_REGULATOR_LP3972) += lp3972.o
 obj-$(CONFIG_REGULATOR_LP872X) += lp872x.o
drivers/regulator/lochnagar-regulator.c new file +255 -0

255 lines not on this page · raw message

Signature · 1 line
2.11.0
maintainer
#4 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

On Fri, Oct 19, 2018 at 10:50:02AM +0100, Charles Keepax wrote:

Please do not submit new versions of already applied patches, please submit incremental updates to the existing code. Modifying existing commits creates problems for other users building on top of those commits so it's best practice to only change pubished git commits if absolutely essential.

drivers/regulator/lochnagar-regulator.c line 3

Quoted 5 lines

+++ b/drivers/regulator/lochnagar-regulator.c

drivers/regulator/lochnagar-regulator.c new file +3 -0
@@ -0,0 +1,255 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Lochnagar regulator driver

Please don't mix C and C++ comments like this in the same block, just have it be a C++ block so it looks consistent.

#5 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 8 lines · Mark Brown

On Fri, Oct 19, 2018 at 10:50:02AM +0100, Charles Keepax wrote:

Please do not submit new versions of already applied patches, please submit incremental updates to the existing code. Modifying existing commits creates problems for other users building on top of those commits so it's best practice to only change pubished git commits if absolutely essential.

Quoted 9 lines

drivers/regulator/lochnagar-regulator.c line 3

Quoted 5 lines

+++ b/drivers/regulator/lochnagar-regulator.c

drivers/regulator/lochnagar-regulator.c new file +3 -0
@@ -0,0 +1,255 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Lochnagar regulator driver

Please don't mix C and C++ comments like this in the same block, just have it be a C++ block so it looks consistent.

Most SPDX headers on C files that I've looked at have it this way with a C++ style comment above a C-style comment, though some don't. license-rules.rst doesn't define how or if a SPDX comment line should be merged with the following file header comment. I've had a bunch of patches in different subsystems all accepted with this mixed format (copied from existing files). Doing the same as existing files sounds reasonable but often isn't in the Linux kernel. It's a common problem/barrier to kernel programming that existing code isn't a guide and there isn't a consistent style across the kernel so one never really knows what the coding style is until you've pushed a patch and annoyed a maintainer. And then you adopt that style on your next patch and annoy different maintainer.

Maybe someone should update license-rules.rst to make a definite statement of the style instead of leaving it to become another style that varies across the kernel and between files.

maintainer
#6 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 5 lines · Richard Fitzgerald

Most SPDX headers on C files that I've looked at have it this way with a C++ style comment above a C-style comment, though some don't. license-rules.rst doesn't define how or if a SPDX comment line should be merged with the following file header comment. I've had a bunch of patches in different subsystems all accepted with this mixed format (copied from existing files). Doing the same as

Right, a lot of the conversions seem to have been done very mechanically.

Quoted 3 lines

Maybe someone should update license-rules.rst to make a definite statement of the style instead of leaving it to become another style that varies across the kernel and between files.

Well volunteered!

author maintainer
#7 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

In reply to Mark Brown
Quoted 8 lines · Mark Brown

On Fri, Oct 19, 2018 at 10:50:02AM +0100, Charles Keepax wrote:

Please do not submit new versions of already applied patches, please submit incremental updates to the existing code. Modifying existing commits creates problems for other users building on top of those commits so it's best practice to only change pubished git commits if absolutely essential.

I don't think any of this has been applied anywhere yet.

Quoted 8 lines

drivers/regulator/lochnagar-regulator.c line 3

Quoted 5 lines

+++ b/drivers/regulator/lochnagar-regulator.c

drivers/regulator/lochnagar-regulator.c new file +3 -0
@@ -0,0 +1,255 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Lochnagar regulator driver

Please don't mix C and C++ comments like this in the same block, just have it be a C++ block so it looks consistent.

Can do.

Thanks,
Charles

maintainer
#8 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 9 lines · Charles Keepax
Quoted 5 lines · Mark Brown

Please do not submit new versions of already applied patches, please submit incremental updates to the existing code. Modifying existing commits creates problems for other users building on top of those commits so it's best practice to only change pubished git commits if absolutely essential.

I don't think any of this has been applied anywhere yet.

It looks a lot like

bef9391cbec547351c6a13e52f3a26bb2d271ec7 regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

in -next.

author maintainer
#9 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 9 lines · Mark Brown
Quoted 7 lines · Charles Keepax
Quoted 5 lines · Mark Brown

Please do not submit new versions of already applied patches, please submit incremental updates to the existing code. Modifying existing commits creates problems for other users building on top of those commits so it's best practice to only change pubished git commits if absolutely essential.

Quoted 7 lines
Quoted 1 line

I don't think any of this has been applied anywhere yet.

It looks a lot like

bef9391cbec547351c6a13e52f3a26bb2d271ec7 regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

in -next.

Well it sure does look a lot like my patch :-). Apologies something must have gone wrong on one of our ends as I don't seem to have ever received your usual confirmation email it was merged. I will try to keep a closer eye on people's trees in future.

No changes in this version, was just updating other patches in the chain for some feedback so no harm done. Will send an incremental patch for comment style.

Thanks,
Charles

maintainer
#10 lore raw

Re: [PATCH v3 4/5] regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 6 lines · Charles Keepax
Quoted 3 lines · Mark Brown

It looks a lot like

bef9391cbec547351c6a13e52f3a26bb2d271ec7 regulator: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 7 lines
Quoted 1 line

in -next.

Well it sure does look a lot like my patch :-). Apologies something must have gone wrong on one of our ends as I don't seem to have ever received your usual confirmation email it was merged. I will try to keep a closer eye on people's trees in future.

They do sometimes seem to get flagged as spam, I think due to the amount of boilerplate and possibly even the fact that they include the patches.

author maintainer
#11 lore raw

PATCH v3 5/5 pinctrl: lochnagar: Add support for the Cirrus Logic Lochnagar

In reply to Charles Keepax

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

Lochnagar provides many pins which can generally be used for an audio function such as an AIF or a PDM interface, but also as GPIOs.

---

Changes since v2:
- Updated aif-master/aif-slave to use a vendor prefix
- Correctly get and put of_node pointer in probe/remove

Thanks,
Charles

 drivers/pinctrl/cirrus/Kconfig             |   10 +
 drivers/pinctrl/cirrus/Makefile            |    2 +
 drivers/pinctrl/cirrus/pinctrl-lochnagar.c | 1167 ++++++++++++++++++++++++++++
 drivers/pinctrl/cirrus/pinctrl-lochnagar.h |  112 +++
 4 files changed, 1291 insertions(+)
 create mode 100644 drivers/pinctrl/cirrus/pinctrl-lochnagar.c
 create mode 100644 drivers/pinctrl/cirrus/pinctrl-lochnagar.h
drivers/pinctrl/cirrus/Kconfig +10 -0
index 27013e5949bc1..74af07e251741 100644
@@ -1,3 +1,13 @@
+config PINCTRL_LOCHNAGAR
+	tristate "Cirrus Logic Lochnagar pinctrl driver"
+	depends on MFD_LOCHNAGAR
+	select PINMUX
+	select PINCONF
+	select GENERIC_PINCONF
+	help
+	  This driver supports configuring the GPIO and other pin configuration
+	  of the Cirrus Logic Lochnagar audio development board.
+
 # This is all selected by the Madera MFD driver Kconfig options
 config PINCTRL_MADERA
 	tristate
drivers/pinctrl/cirrus/Makefile +2 -0
index 6e4938cde9e30..20baebf438f62 100644
@@ -1,4 +1,6 @@
 # Cirrus Logic pinctrl drivers
+obj-$(CONFIG_PINCTRL_LOCHNAGAR)	+= pinctrl-lochnagar.o
+
 pinctrl-madera-objs		:= pinctrl-madera-core.o
 ifeq ($(CONFIG_PINCTRL_CS47L35),y)
 pinctrl-madera-objs		+= pinctrl-cs47l35.o
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +1167 -0

1,167 lines not on this page · raw message

drivers/pinctrl/cirrus/pinctrl-lochnagar.h new file +112 -0

112 lines not on this page · raw message

Signature · 1 line
2.11.0
#12 lore raw

Re: [PATCH v3 5/5] pinctrl: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 11 lines · Charles Keepax

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

Lochnagar provides many pins which can generally be used for an audio function such as an AIF or a PDM interface, but also as GPIOs.

Quoted 6 lines

---

Changes since v2:
- Updated aif-master/aif-slave to use a vendor prefix
- Correctly get and put of_node pointer in probe/remove

Looks better and better! Some comments, probably not the last comments:

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 20

Quoted 10 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +10 -0
+#include <linux/err.h>
+#include <linux/errno.h>
+#include <linux/gpio/driver.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/regmap.h>
+#include <linux/pinctrl/pinctrl.h>
+#include <linux/pinctrl/pinmux.h>
+#include <linux/pinctrl/pinconf.h>
+#include <linux/pinctrl/pinconf-generic.h>

#include <linux/bits.h>

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 296

Quoted 6 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +6 -0
+struct lochnagar_aif {
+       const char name[16];
+
+       unsigned int pins[4];
+
+       unsigned int src_reg;

u32?

Quoted 1 line

+ unsigned int src_mask;

u32?

Review

Quoted 2 lines
(quoted diff) +2 -0
+
+       unsigned int ctrl_reg;

u32?

Quoted 1 line

+ unsigned int ena_mask;

u32?

Quoted 1 line

+ unsigned int master_mask;

u32?

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 370

Quoted 6 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +6 -0
+struct lochnagar_func {
+       const char * const name;
+
+       enum lochnagar_func_type type;
+
+       int op;

unsigned int? u32?

Looks like u8 actually.

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 539

Quoted 7 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +7 -0
+struct lochnagar_group {
+       const char * const name;
+
+       enum lochnagar_func_type type;
+
+       const unsigned int *pins;
+       int npins;

unsigned int npins?

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 605

Quoted 3 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +3 -0
+struct lochnagar_func_groups {
+       const char **groups;
+       int ngroups;

unsigned int ngroups?

Quoted 7 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +7 -0
+struct lochnagar_pin_priv {
+       struct lochnagar *lochnagar;
+       struct device *dev;
+
+       const struct lochnagar_func *funcs;
+       int nfuncs;
+

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 624

Quoted 10 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +10 -0
+       const struct pinctrl_pin_desc *pins;
+       int npins;
+
+       const struct lochnagar_group *groups;
+       int ngroups;
+
+       struct lochnagar_func_groups func_groups[LN_FTYPE_COUNT];
+
+       struct gpio_chip gpio_chip;
+};

I bet some of these should be unsigned as well.

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 958

Quoted 4 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +4 -0
+static const struct pinconf_generic_params lochnagar_dt_params[] = {
+       {"cirrus,aif-master", PIN_CONFIG_AIFMASTER,  0},
+       {"cirrus,aif-slave",  PIN_CONFIG_AIFSLAVE,   0},
+};

I guess these are documented in the device tree bindings.

They look suspciously like muxing but I guess it is explained there.

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 986

Quoted 9 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +9 -0
+static void lochnagar_gpio_set(struct gpio_chip *chip,
+                              unsigned int offset, int value)
+{
+       struct lochnagar_pin_priv *priv = gpiochip_get_data(chip);
+       struct lochnagar *lochnagar = priv->lochnagar;
+       const struct lochnagar_pin *pin = priv->pins[offset].drv_data;
+       int ret;
+
+       value = !!value;

value = value ? BIT(pin->shift) : 0;

Quoted 5 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +5 -0
+       dev_dbg(priv->dev, "Set GPIO %s to %s\n",
+               pin->name, value ? "high" : "low");
+
+       switch (pin->type) {
+       case LN_PTYPE_MUX:

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 1002

Quoted 10 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +10 -0
+               value |= LN2_OP_GPIO;
+
+               ret = lochnagar_pin_set_mux(priv, pin, value);
+               break;
+       case LN_PTYPE_GPIO:
+               if (pin->invert)
+                       value = !value;
+
+               ret = regmap_update_bits(lochnagar->regmap, pin->reg,
+                                        0x1 << pin->shift,

BIT(pin->shift)

Quoted 1 line

+ value << pin->shift);

Just value provided you used the construction above to construct it.

Yours,
Linus Walleij

author maintainer
#13 lore raw

Re: [PATCH v3 5/5] pinctrl: lochnagar: Add support for the Cirrus Logic Lochnagar

Quoted 14 lines · Linus Walleij
Quoted 11 lines · Charles Keepax

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

Lochnagar provides many pins which can generally be used for an audio function such as an AIF or a PDM interface, but also as GPIOs.

Quoted 14 lines

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 986

Quoted 11 lines

---

drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +9 -0
+static void lochnagar_gpio_set(struct gpio_chip *chip,
+                              unsigned int offset, int value)
+{
+       struct lochnagar_pin_priv *priv = gpiochip_get_data(chip);
+       struct lochnagar *lochnagar = priv->lochnagar;
+       const struct lochnagar_pin *pin = priv->pins[offset].drv_data;
+       int ret;
+
+       value = !!value;

value = value ? BIT(pin->shift) : 0;

I think this will end up more complex because...

Quoted 6 lines

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 993

Quoted 6 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +6 -0
+       dev_dbg(priv->dev, "Set GPIO %s to %s\n",
+               pin->name, value ? "high" : "low");
+
+       switch (pin->type) {
+       case LN_PTYPE_MUX:
+               value |= LN2_OP_GPIO;

I want the value to be in the lowest bit for this path.

Quoted 6 lines

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 999

Quoted 6 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +6 -0
+
+               ret = lochnagar_pin_set_mux(priv, pin, value);
+               break;
+       case LN_PTYPE_GPIO:
+               if (pin->invert)
+                       value = !value;

And then I need to invert the value here.

Quoted 11 lines

drivers/pinctrl/cirrus/pinctrl-lochnagar.c line 1002

Quoted 3 lines
drivers/pinctrl/cirrus/pinctrl-lochnagar.c new file +3 -0
+
+               ret = regmap_update_bits(lochnagar->regmap, pin->reg,
+                                        0x1 << pin->shift,

BIT(pin->shift)

Quoted 1 line

+ value << pin->shift);

Just value provided you used the construction above to construct it.

All the other comments look good will fixup for the next spin.

Thanks,
Charles

maintainer Acked-by on v3 1/5
#14 lore raw
In reply to Charles Keepax

Quoting Charles Keepax (2018-10-19 02:49:59)

Quoted 10 lines

Lochnagar is an evaluation and development board for Cirrus Logic Smart CODEC and Amp devices. It allows the connection of most Cirrus Logic devices on mini-cards, as well as allowing connection of various application processor systems to provide a full evaluation platform. This driver supports the board controller chip on the Lochnagar board.

---

#15 lore raw
In reply to Charles Keepax

Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt line 149

Quoted 8 lines · Charles Keepax
Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt new file +8 -0
+      gf-aif2-txdat, usb-aif1, usb-aif2, adat-aif, soundcard-aif,
+
+  - aif-master : Specifies that an AIF group will be used as a master
+    interface (either this or aif-slave is required if a group is
+    being muxed to an AIF)
+  - aif-slave : Specifies that an AIF group will be used as a slave
+    interface (either this or aif-master is required if a group is
+    being muxed to an AIF)

This is not properly described as pin config parameters, but that is how they are used in the driver. Please describe that this is supposed to augment the pin config of the pins.

But I think it looks bogus. If the pins are already mixed to groups like that:

Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt line 212

Quoted 12 lines
Documentation/devicetree/bindings/mfd/cirrus,lochnagar.txt new file +12 -0
+       pin-settings: pin-settings {
+               ap-aif {
+                       aif-slave;
+                       groups = "gf-aif1";
+                       function = "codec-aif3";
+               };
+               codec-aif {
+                       aif-master;
+                       groups = "codec-aif3";
+                       function = "gf-aif1";
+               };
+       };

OK so what the "special properties" above indicates is really the direction of the pins, whether out (master) or in (slave".

Just use the standard bool pin config properties:
input-enable;
output-enable;

Reference Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt

For this. If you want users to see that this is master and slave, just /* Write a comment */ in the device tree.

Yours,
Linus Walleij