devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Naidu Tellapati <naidu.tellapati@gmail.com>
To: thierry.reding@gmail.com, abrestic@chromium.org,
	gregkh@linuxfoundation.org, arnd@arndb.de,
	James.Hartley@imgtec.com, Ezequiel.Garcia@imgtec.com
Cc: devicetree@vger.kernel.org, linux-pwm@vger.kernel.org,
	Arul.Ramasamy@imgtec.com, Sai.Masarapu@imgtec.com,
	Naidu Tellapati <Naidu.Tellapati@gmail.com>,
	Naidu Tellapati <Naidu.Tellapati@imgtec.com>
Subject: [PATCH v6 4/4] DT: pdm: Add binding document for IMG PDM DAC
Date: Fri, 28 Nov 2014 23:42:25 +0530	[thread overview]
Message-ID: <1417198345-19633-5-git-send-email-Naidu.Tellapati@gmail.com> (raw)
In-Reply-To: <1417198345-19633-1-git-send-email-Naidu.Tellapati@gmail.com>

Add binding document for the Pulse Density Modulator (PDM) DAC present on the
Pistachio SOC.

Signed-off-by: Naidu Tellapati <Naidu.Tellapati@imgtec.com>
Signed-off-by: Arul Ramasamy <Arul.Ramasamy@imgtec.com>
---
 Documentation/devicetree/bindings/misc/img-pdm.txt |   54 ++++++++++++++++++++
 1 files changed, 54 insertions(+), 0 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/misc/img-pdm.txt

diff --git a/Documentation/devicetree/bindings/misc/img-pdm.txt b/Documentation/devicetree/bindings/misc/img-pdm.txt
new file mode 100644
index 0000000..a530f4b
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/img-pdm.txt
@@ -0,0 +1,54 @@
+*Imagination Technologies Pulse Density Modulator (PDM) DAC.
+
+Required properties:
+- compatible: Must be "img,pistachio-pdm"
+- clocks: phandle to input PDM clock
+- clock-names: Must include the following entry:
+  - pdm: input clock to pdm block.
+- img,cr-periph: Must contain a phandle to the peripheral control
+  syscon node which contains PDM control registers.
+- #pdm-cells: Must be 2.
+- The first cell is the PDM channel number (valid values: 0, 1, 2, 3)
+- The second cell is 12-bit pulse-in value
+
+Specifying PDM information for devices
+======================================
+
+1. PDM User nodes
+
+PDM properties should be named "pdms". The exact meaning of each pdms property
+is described above.
+
+	pdm-specifier : array of #pdm-cells specifying the given PDM
+						(controller specific)
+
+The following example could be used to describe a PDM-based backlight device:
+
+	pdm: pdm {
+		#pdm-cells = <2>;
+	};
+
+	[...]
+
+	bl: backlight {
+		pdms = <&pdm 2 0>;
+	};
+
+pdm-specifier typically encodes the chip-relative PDM channel number and the
+12-bit pulse-in value.
+
+2. PDM Controller nodes
+
+PDM controller nodes must specify the number of cells used for the specifier
+using the '#pdm-cells' property.
+
+An example PDM controller might look like this:
+
+Example:
+	pdm: pdm@18148000 {
+		compatible = "img,pistachio-pdm";
+		clocks = <&pdm_clk>;
+		clk-names = "pdm";
+		img,cr-periph = <&cr_periph>;
+		#pdm-cells = <2>;
+	};
-- 
1.7.0.4


  parent reply	other threads:[~2014-11-28 18:12 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-28 18:12 [PATCH v6 0/4] Initial support for ImgTec PWM DAC and PDM DAC Naidu Tellapati
2014-11-28 18:12 ` [PATCH v6 1/4] pwm: Imagination Technologies PWM DAC driver Naidu Tellapati
2014-11-28 18:12 ` [PATCH v6 2/4] DT: pwm: Add binding document for IMG PWM DAC Naidu Tellapati
2014-11-28 18:12 ` [PATCH v6 3/4] pdm: Imagination Technologies PDM DAC driver Naidu Tellapati
2014-11-28 18:12 ` Naidu Tellapati [this message]
2014-12-05 11:52 ` [PATCH v6 0/4] Initial support for ImgTec PWM DAC and PDM DAC Ezequiel Garcia

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1417198345-19633-5-git-send-email-Naidu.Tellapati@gmail.com \
    --to=naidu.tellapati@gmail.com \
    --cc=Arul.Ramasamy@imgtec.com \
    --cc=Ezequiel.Garcia@imgtec.com \
    --cc=James.Hartley@imgtec.com \
    --cc=Naidu.Tellapati@imgtec.com \
    --cc=Sai.Masarapu@imgtec.com \
    --cc=abrestic@chromium.org \
    --cc=arnd@arndb.de \
    --cc=devicetree@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-pwm@vger.kernel.org \
    --cc=thierry.reding@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).