On Thu, Aug 15, 2013 at 01:57:13PM +0100, Srinivas KANDAGATLA wrote:
> Thanks Mark for your comments.
>
> On 15/08/13 09:49, Mark Rutland wrote:
> > On Wed, Aug 14, 2013 at 06:27:01PM +0100, Srinivas KANDAGATLA wrote:
> >> From: Srinivas Kandagatla <srinivas.kandagatla@xxxxxx>
> >>
> >> This patch adds support to ST RC driver, which is basically a IR/UHF
> >> receiver and transmitter. This IP is common across all the ST parts for
> >> settop box platforms. IRB is embedded in ST COMMS IP block.
> >> It supports both Rx & Tx functionality.
> >>
> >> In this driver adds only Rx functionality via LIRC codec.
> >
> > Is there anything that additionally needs to be in the dt to support Tx
> > functionality?
>
> We need an additional boolean property for TX enable.
Why? Becuase you might not have something wired up for Tx?
What needs to be present physically for Tx support?
>
> +
>
> Two more configurable parameters for TX sub-carrier frequency and
> duty-cycle. By default driver can set the sub carrier frequency to be
> 38Khz and duty cycle as 50%.
> However I don't have strong use case to make these configurable.
>
> So, I think just one boolean property to enable tx should be Ok.
>
> >
> >>
> >> Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@xxxxxx>
> >> ---
> >> Hi Chehab,
> >>
> >> This is a very simple rc driver for IRB controller found in STi ARM CA9 SOCs.
> >> STi ARM SOC support went in 3.11 recently.
> >> This driver is a raw driver which feeds data to lirc codec for the user lircd
> >> to decode the keys.
> >>
> >> This patch is based on git://linuxtv.org/media_tree.git master branch.
> >>
> >> Comments?
> >>
> >> Thanks,
> >> srini
> >>
> >> Documentation/devicetree/bindings/media/st-rc.txt | 18 +
> >> drivers/media/rc/Kconfig | 10 +
> >> drivers/media/rc/Makefile | 1 +
> >> drivers/media/rc/st_rc.c | 371 +++++++++++++++++++++
> >> 4 files changed, 400 insertions(+), 0 deletions(-)
> >> create mode 100644 Documentation/devicetree/bindings/media/st-rc.txt
> >> create mode 100644 drivers/media/rc/st_rc.c
> >>
> >> diff --git a/Documentation/devicetree/bindings/media/st-rc.txt b/Documentation/devicetree/bindings/media/st-rc.txt
> >> new file mode 100644
> >> index 0000000..57f9ee8
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/media/st-rc.txt
> >> @@ -0,0 +1,18 @@
> >> +Device-Tree bindings for ST IR and UHF receiver
> >> +
> >> +Required properties:
> >> + - compatible: should be "st,rc".
> >
> > That "rc" should be made more specific, and it seems like this is a
> > subset of a larger block of IP (the ST COMMS IP block). Is this really a
> > standalone piece of hardware, or is it always in the larger comms block?
> COMMS block is a collection of communication peripherals, and IRB(Infra
> red blaster) is always part of the COMMS block.
>
> May renaming the compatible to "st,comms-rc" might be more clear.
Given the actual name of the hardware seems to include "irb", I think
"irb" makes more sense than "rc" in the compatible string. Is there no
more specific name than "Infra Red Blaster"?
>
> >
> > What's the full name of this unit as it appears in documentation?
> It is always refered as the Communication sub-system (COMMS) which is a
> collection of communication peripherals like UART, I2C, SPI, IRB.
Ok, are those separate IP blocks within a container, or is anything
shared? Does the COMMS block have any registers shared between those
units, for example?
>
> >
> >> + - st,uhfmode: boolean property to indicate if reception is in UHF.
> >
> > That's not a very clear name. Is this a physical property of the device
> > (i.e. it's wired to either an IR receiver or a UHF receiver), or is this
> > a choice as to how it's used at runtime?
>
> Its both, some boards have IR and others UHF receivers, So it becomes
> board choice here.
When you say it's both, what do you mean? Is it possible for a unit to
be wired with both IR and UHF support simultaneously, even if the Linux
driver can't handle that?
The dt should encode information about the hardware, not the way you
intend to use the hardware at the present moment in time.
> And also the driver has different register set for UHF receiver and IR
> receiver. This options selects which registers to use depending on mode
> of reception.
Ok, but that's an implementation issue. If you described that IR *may*
be used, and UHF *may* be used, the driver can choose what to do based
on that.
>
> >
> > If it's fixed property of how the device is wired, it might make more
> > sense to have a string mode property that's either "uhf" or "infared".
>
> Am ok with either approaches.
It sounds like we may need separate properties as mentioned above, or a
supported-modes list, perhaps.
>
> >
> >> + - reg: base physical address of the controller and length of memory
> >> + mapped region.
> >> + - interrupts: interrupt number to the cpu. The interrupt specifier
> >> + format depends on the interrupt controller parent.
> >> +
> >> +Example node:
> >> +
> >> + rc: rc@fe518000 {
> >> + compatible = "st,rc";
> >> + reg = <0xfe518000 0x234>;
> >> + interrupts = <0 203 0>;
> >> + };
> >> +
> >
> > [...]
> >
> >> +++ b/drivers/media/rc/st_rc.c
> >> @@ -0,0 +1,371 @@
> >> +/*
> >> + * Copyright (C) 2013 STMicroelectronics Limited
> >> + * Author: Srinivas Kandagatla <srinivas.kandagatla@xxxxxx>
> >> + *
> >> + * This program is free software; you can redistribute it and/or modify
> >> + * it under the terms of the GNU General Public License as published by
> >> + * the Free Software Foundation; either version 2 of the License, or
> >> + * (at your option) any later version.
> >> + */
> >> +#include <linux/kernel.h>
> >> +#include <linux/clk.h>
> >> +#include <linux/interrupt.h>
> >> +#include <linux/module.h>
> >> +#include <linux/of.h>
> >> +#include <linux/platform_device.h>
> >> +#include <media/rc-core.h>
> >> +#include <linux/pinctrl/consumer.h>
> >> +
> >> +struct st_rc_device {
> >> + struct device *dev;
> >> + int irq;
> >> + int irq_wake;
> >> + struct clk *sys_clock;
> >> + void *base; /* Register base address */
> >> + void *rx_base;/* RX Register base address */
> >> + struct rc_dev *rdev;
> >> + bool overclocking;
> >> + int sample_mult;
> >> + int sample_div;
> >> + bool rxuhfmode;
> >> +};
> >
> > [...]
> >
> >> +static void st_rc_hardware_init(struct st_rc_device *dev)
> >> +{
> >> + int baseclock, freqdiff;
> >> + unsigned int rx_max_symbol_per = MAX_SYMB_TIME;
> >> + unsigned int rx_sampling_freq_div;
> >> +
> >> + clk_prepare_enable(dev->sys_clock);
> >
> > This clock should be defined in the binding.
> Clock is coming for the device tree only.
>
> I can add the clock and pinctrl bindings to the documentation if it
> makes it more clear.
If we need clocks and pinctrl, they should be described form the start.
Given we already have the infrastructure, there's no reason not to. Not
doing so will only lead to headaches later as we try to keep bindings
stable.
>
> >
> >> + baseclock = clk_get_rate(dev->sys_clock);
> >> +
> >> + /* IRB input pins are inverted internally from high to low. */
> >> + writel(1, dev->rx_base + IRB_RX_POLARITY_INV);
> >> +
> >> + rx_sampling_freq_div = baseclock / IRB_SAMPLE_FREQ;
> >> + writel(rx_sampling_freq_div, dev->base + IRB_SAMPLE_RATE_COMM);
> >> +
> >> + freqdiff = baseclock - (rx_sampling_freq_div * IRB_SAMPLE_FREQ);
> >> + if (freqdiff) { /* over clocking, workout the adjustment factors */
> >> + dev->overclocking = true;
> >> + dev->sample_mult = 1000;
> >> + dev->sample_div = baseclock / (10000 * rx_sampling_freq_div);
> >> + rx_max_symbol_per = (rx_max_symbol_per * 1000)/dev->sample_div;
> >> + }
> >> +
> >> + writel(rx_max_symbol_per, dev->rx_base + IRB_MAX_SYM_PERIOD);
> >> +}
> >> +
> >> +static int st_rc_remove(struct platform_device *pdev)
> >> +{
> >> + struct st_rc_device *rc_dev = platform_get_drvdata(pdev);
> >> + clk_disable_unprepare(rc_dev->sys_clock);
> >> + rc_unregister_device(rc_dev->rdev);
> >
> > Is a call to rc_free_device() not necessary?
> >
> > There are separate calls to rc_allocate_device() and rc_register_device
> > in the probe function, and an rc_free_device() in its failure path.
> >
> rc_unregister_device does call rc_free_device as well.
I see. That's a somewhat confusing API design, but that's not down to
you.
Thanks,
Mark.
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
