All of lore.kernel.org
 help / color / mirror / Atom feed
From: Arnd Bergmann <arnd@arndb.de>
To: Lee Jones <lee.jones@linaro.org>
Cc: linux-arm-kernel@lists.infradead.org, cjb@laptop.org,
	niklas.hernaeus@linaro.org, linux-mmc@vger.kernel.org
Subject: Re: [PATCH 5/5] MMC: mmci: Add required documentation for Device Tree bindings
Date: Thu, 15 Mar 2012 17:53:25 +0000	[thread overview]
Message-ID: <201203151753.25774.arnd@arndb.de> (raw)
In-Reply-To: <1331734803-17954-6-git-send-email-lee.jones@linaro.org>

On Wednesday 14 March 2012, Lee Jones wrote:

Some more comments about the individual properties

> +Required properties:
> +- compatible             : contains "arm,pl18x", "arm,primecell".

Better use the exact number for 'x' here.

> +- reg                    : contains pl18x registers and length.
> +- interrupts             : contains the device IRQ(s).

You should document what the first and second interrupts are,
respectively, if there is more than one.

> +- arm,primecell-periphid : contains the PrimeCell Peripheral ID.

This one should be optional.

> +
> +Optional properties:
> +- ocr_mask               : contains the regulator oscillator mask

Not sure about this one. If it's for the regulators, we should be
using the regulator bindings.

> +- wp-gpios               : contains any write protect (ro) gpios
> +- cd-gpios               : contains any card detection gpios
> +- cd-invert              : indicates whether the cd gpio is inverted 
> +- clock_frequency        : contains the maximum operating frequency

The name should be 'clock-frequency', not 'clock_frequency'.

> +- mmc_cap_4_bit_data     : indicates whether device is 4 bit capable
> +- mmc_cap_8_bit_data     : indicates whether device is 8 bit capable
> +- mmc_cap_mmc_highspeed  : indicates whether MMC is high speed capable
> +- mmc_cap_sd_highspeed   : indicates whether SD is high speed capable

I would strongly recommend using the same naming as sdhci here. I think
tegra has set a precedent.

> +ux500 variant specific properties:
> +- gpio-en                : contains the level-shifter enable gpio
> +- gpio-vsel              : contains the level-shifter voltage select gpio

I think these need to be 'en-gpios' and 'vsel-gpios', in order for the
gpio binding to work.

> +- tx_dst_dev_type        : contains the tx destination device (DMA) 
> +- rx_src_dev_type        : contains the rx source device (DMA)

As Russell commented already, these should not be here.

	Arnd

WARNING: multiple messages have this Message-ID (diff)
From: arnd@arndb.de (Arnd Bergmann)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH 5/5] MMC: mmci: Add required documentation for Device Tree bindings
Date: Thu, 15 Mar 2012 17:53:25 +0000	[thread overview]
Message-ID: <201203151753.25774.arnd@arndb.de> (raw)
In-Reply-To: <1331734803-17954-6-git-send-email-lee.jones@linaro.org>

On Wednesday 14 March 2012, Lee Jones wrote:

Some more comments about the individual properties

> +Required properties:
> +- compatible             : contains "arm,pl18x", "arm,primecell".

Better use the exact number for 'x' here.

> +- reg                    : contains pl18x registers and length.
> +- interrupts             : contains the device IRQ(s).

You should document what the first and second interrupts are,
respectively, if there is more than one.

> +- arm,primecell-periphid : contains the PrimeCell Peripheral ID.

This one should be optional.

> +
> +Optional properties:
> +- ocr_mask               : contains the regulator oscillator mask

Not sure about this one. If it's for the regulators, we should be
using the regulator bindings.

> +- wp-gpios               : contains any write protect (ro) gpios
> +- cd-gpios               : contains any card detection gpios
> +- cd-invert              : indicates whether the cd gpio is inverted 
> +- clock_frequency        : contains the maximum operating frequency

The name should be 'clock-frequency', not 'clock_frequency'.

> +- mmc_cap_4_bit_data     : indicates whether device is 4 bit capable
> +- mmc_cap_8_bit_data     : indicates whether device is 8 bit capable
> +- mmc_cap_mmc_highspeed  : indicates whether MMC is high speed capable
> +- mmc_cap_sd_highspeed   : indicates whether SD is high speed capable

I would strongly recommend using the same naming as sdhci here. I think
tegra has set a precedent.

> +ux500 variant specific properties:
> +- gpio-en                : contains the level-shifter enable gpio
> +- gpio-vsel              : contains the level-shifter voltage select gpio

I think these need to be 'en-gpios' and 'vsel-gpios', in order for the
gpio binding to work.

> +- tx_dst_dev_type        : contains the tx destination device (DMA) 
> +- rx_src_dev_type        : contains the rx source device (DMA)

As Russell commented already, these should not be here.

	Arnd

  parent reply	other threads:[~2012-03-15 17:53 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-03-14 14:19 [PATCH 0/5] MMC: mmci: Provide bindings for Device Tree Lee Jones
2012-03-14 14:19 ` Lee Jones
2012-03-14 14:19 ` [PATCH 1/5] MMC: mmci: Seperate ux500 variants from generic code Lee Jones
2012-03-14 14:19   ` Lee Jones
2012-03-14 14:20 ` [PATCH 2/5] MMC: mmci: Seperate ARM " Lee Jones
2012-03-14 14:20   ` Lee Jones
2012-03-15 17:32   ` Russell King - ARM Linux
2012-03-15 17:32     ` Russell King - ARM Linux
2012-03-15 17:36     ` Lee Jones
2012-03-15 17:36       ` Lee Jones
2012-03-15 17:37       ` Russell King - ARM Linux
2012-03-15 17:37         ` Russell King - ARM Linux
2012-03-15 17:46         ` Arnd Bergmann
2012-03-15 17:46           ` Arnd Bergmann
2012-03-15 17:54           ` Russell King - ARM Linux
2012-03-15 17:54             ` Russell King - ARM Linux
2012-03-15 18:23             ` Arnd Bergmann
2012-03-15 18:23               ` Arnd Bergmann
2012-03-15 20:30               ` Russell King - ARM Linux
2012-03-15 20:30                 ` Russell King - ARM Linux
2012-03-16 12:48                 ` Arnd Bergmann
2012-03-16 12:48                   ` Arnd Bergmann
2012-03-17 21:30                   ` Mark Brown
2012-03-17 21:30                     ` Mark Brown
2012-03-15 17:38       ` Lee Jones
2012-03-15 17:38         ` Lee Jones
2012-03-14 14:20 ` [PATCH 3/5] MMC: mmci: Add generic Device Tree bindings to mmci core code Lee Jones
2012-03-14 14:20   ` Lee Jones
2012-03-15 15:12   ` Per Forlin
2012-03-15 15:12     ` Per Forlin
2012-03-15 15:25     ` Lee Jones
2012-03-15 15:25       ` Lee Jones
2012-03-14 14:20 ` [PATCH 4/5] MMC: mmci: Enable Device Tree support for ux500 variants Lee Jones
2012-03-14 14:20   ` Lee Jones
2012-03-14 14:20 ` [PATCH 5/5] MMC: mmci: Add required documentation for Device Tree bindings Lee Jones
2012-03-14 14:20   ` Lee Jones
2012-03-15 17:35   ` Russell King - ARM Linux
2012-03-15 17:35     ` Russell King - ARM Linux
2012-03-15 17:49     ` Arnd Bergmann
2012-03-15 17:49       ` Arnd Bergmann
2012-03-15 17:58       ` Russell King - ARM Linux
2012-03-15 17:58         ` Russell King - ARM Linux
2012-03-15 17:53   ` Arnd Bergmann [this message]
2012-03-15 17:53     ` Arnd Bergmann
2012-03-15 17:59     ` Russell King - ARM Linux
2012-03-15 17:59       ` Russell King - ARM Linux
2012-03-15 15:06 ` [PATCH 0/5] MMC: mmci: Provide bindings for Device Tree Per Forlin
2012-03-15 15:06   ` Per Forlin
2012-03-15 15:25   ` Lee Jones
2012-03-15 15:25     ` Lee Jones
2012-03-15 15:32     ` Arnd Bergmann
2012-03-15 15:32       ` Arnd Bergmann
2012-03-15 15:44       ` Lee Jones
2012-03-15 15:44         ` Lee Jones
2012-03-15 19:12       ` Per Forlin
2012-03-15 19:12         ` Per Forlin
2012-03-15 20:36         ` Russell King - ARM Linux
2012-03-15 20:36           ` Russell King - ARM Linux
2012-03-15 20:58         ` Arnd Bergmann
2012-03-15 20:58           ` Arnd Bergmann
2012-03-16  9:01           ` Linus Walleij
2012-03-16  9:01             ` Linus Walleij
2012-03-16 12:36             ` Arnd Bergmann
2012-03-16 12:36               ` Arnd Bergmann
2012-03-17 21:26               ` Mark Brown
2012-03-17 21:26                 ` Mark Brown

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=201203151753.25774.arnd@arndb.de \
    --to=arnd@arndb.de \
    --cc=cjb@laptop.org \
    --cc=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-mmc@vger.kernel.org \
    --cc=niklas.hernaeus@linaro.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.