Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
Hello Grant, On Wed, Jan 21, 2009 at 01:55:07PM -0700, Grant Likely wrote: > From: Grant Likely > > This patch updates the mpc5200 binding documentation to match > actual usage conventions, to remove incorrect information, and > to remove topics which are more thoroughly described elsewhere. > > Signed-off-by: Grant Likely > CC: devtree-disc...@ozlabs.org > CC: Wolfram Sang Can you please send the updated version so I could add an reviewed-by? Regards, Wolfram -- Dipl.-Ing. Wolfram Sang | http://www.pengutronix.de Pengutronix - Linux Solutions for Science and Industry signature.asc Description: Digital signature ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
On Tue, Jan 27, 2009 at 11:00 AM, Matt Sealey wrote: > On Wed, Jan 21, 2009 at 2:55 PM, Grant Likely > wrote: >> From: Grant Likely >> >> This patch updates the mpc5200 binding documentation to match >> actual usage conventions, to remove incorrect information, and >> to remove topics which are more thoroughly described elsewhere. >> >> Signed-off-by: Grant Likely >> CC: devtree-disc...@ozlabs.org >> CC: Wolfram Sang >> --- >> +It is *strongly* recommended that 5200B device trees follow this convention >> +(instead of only listing the base mpc5200 item). >> + >> +ie. ethernet on mpc5200: compatible = "fsl,mpc5200-ethernet"; >> +ethernet on mpc5200b: compatible = "fsl,mpc5200b-ethernet", >> + "fsl,mpc5200-ethernet"; > > snip > >> +ethernet@fsl,mpc5200-fec MPC5200 ethernet device > > snip > >> +fsl,mpc5200-fec nodes >> +- >> +The FEC node can specify one of the following properties to configure >> +the MII link: > > > Is it fec or ethernet? Obviously the first one is an example only but > it should least reflect real life.. Good catch. It should be -fec. Fixed. g. -- Grant Likely, B.Sc., P.Eng. Secret Lab Technologies Ltd. ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
On Wed, Jan 21, 2009 at 2:55 PM, Grant Likely wrote: > From: Grant Likely > > This patch updates the mpc5200 binding documentation to match > actual usage conventions, to remove incorrect information, and > to remove topics which are more thoroughly described elsewhere. > > Signed-off-by: Grant Likely > CC: devtree-disc...@ozlabs.org > CC: Wolfram Sang > --- > +It is *strongly* recommended that 5200B device trees follow this convention > +(instead of only listing the base mpc5200 item). > + > +ie. ethernet on mpc5200: compatible = "fsl,mpc5200-ethernet"; > +ethernet on mpc5200b: compatible = "fsl,mpc5200b-ethernet", > + "fsl,mpc5200-ethernet"; snip > +ethernet@fsl,mpc5200-fec MPC5200 ethernet device snip > +fsl,mpc5200-fec nodes > +- > +The FEC node can specify one of the following properties to configure > +the MII link: Is it fec or ethernet? Obviously the first one is an example only but it should least reflect real life.. -- Matt Sealey Genesi, Manager, Developer Relations ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
On Mon, Jan 26, 2009 at 2:26 AM, Wolfram Sang wrote: > >> >> +system-frequency Fsystem frequency; source of all >> > >> > Fsystem? Typo? >> >> Not really, that's the name of the clock in the MP5200 user guide. >> I'll clarify what I've written here though. > > That will be helpful. > >> > The unit would be nice here, too, I think. >> >> Unit? Do you mean stating that it is in Hz? > > Yes, like in the frequency next to it. > > Kind regards, > > Wolfram > > PS: The other patches look good to me, too. I just want to test them on > a real phyCORE-tiny this week. Thanks, I want to get these queued up into -next ASAP, so let me know when you've had a chance to try them. g. -- Grant Likely, B.Sc., P.Eng. Secret Lab Technologies Ltd. ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
> >> +system-frequency Fsystem frequency; source of all > > > > Fsystem? Typo? > > Not really, that's the name of the clock in the MP5200 user guide. > I'll clarify what I've written here though. That will be helpful. > > The unit would be nice here, too, I think. > > Unit? Do you mean stating that it is in Hz? Yes, like in the frequency next to it. Kind regards, Wolfram PS: The other patches look good to me, too. I just want to test them on a real phyCORE-tiny this week. -- Dipl.-Ing. Wolfram Sang | http://www.pengutronix.de Pengutronix - Linux Solutions for Science and Industry signature.asc Description: Digital signature ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
On Sun, Jan 25, 2009 at 12:48 PM, Wolfram Sang wrote: > On Wed, Jan 21, 2009 at 01:55:07PM -0700, Grant Likely wrote: >> +system-frequency Fsystem frequency; source of all > > Fsystem? Typo? Not really, that's the name of the clock in the MP5200 user guide. I'll clarify what I've written here though. > The unit would be nice here, too, I think. Unit? Do you mean stating that it is in Hz? >> +cdm@ fsl,mpc5200-cmd Clock Distribution > > ^^ cdm! >> +is for flags which is currently unsused. > > Typo: should be "unused". Good catches, thanks. g. ___ Linuxppc-dev mailing list Linuxppc-dev@ozlabs.org https://ozlabs.org/mailman/listinfo/linuxppc-dev
Re: [PATCH 1/8] powerpc/5200: update device tree binding documentation
Hello Grant, On Wed, Jan 21, 2009 at 01:55:07PM -0700, Grant Likely wrote: > From: Grant Likely > > This patch updates the mpc5200 binding documentation to match > actual usage conventions, to remove incorrect information, and > to remove topics which are more thoroughly described elsewhere. > > Signed-off-by: Grant Likely > CC: devtree-disc...@ozlabs.org > CC: Wolfram Sang > --- > > Documentation/powerpc/dts-bindings/fsl/mpc5200.txt | 181 + > .../powerpc/mpc52xx-device-tree-bindings.txt | 277 > > 2 files changed, 181 insertions(+), 277 deletions(-) > create mode 100644 Documentation/powerpc/dts-bindings/fsl/mpc5200.txt > delete mode 100644 Documentation/powerpc/mpc52xx-device-tree-bindings.txt > > > diff --git a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt > b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt > new file mode 100644 > index 000..1eddda7 > --- /dev/null > +++ b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt > @@ -0,0 +1,181 @@ > +MPC5200 Device Tree Bindings > + > + > +(c) 2006-2009 Secret Lab Technologies Ltd > +Grant Likely > + > +Naming conventions > +-- > +For mpc5200 on-chip devices, the format for each compatible value is > +-[-]. The OS should be able to match a device driver > +to the device based solely on the compatible value. If two drivers > +match on the compatible list; the 'most compatible' driver should be > +selected. > + > +The split between the MPC5200 and the MPC5200B leaves a bit of a > +conundrum. How should the compatible property be set up to provide > +maximum compatibility information; but still accurately describe the > +chip? For the MPC5200; the answer is easy. Most of the SoC devices > +originally appeared on the MPC5200. Since they didn't exist anywhere > +else; the 5200 compatible properties will contain only one item; > +"fsl,mpc5200-". > + > +The 5200B is almost the same as the 5200, but not quite. It fixes > +silicon bugs and it adds a small number of enhancements. Most of the > +devices either provide exactly the same interface as on the 5200. A few > +devices have extra functions but still have a backwards compatible mode. > +To express this information as completely as possible, 5200B device trees > +should have two items in the compatible list: > + compatible = "fsl,mpc5200b-","fsl,mpc5200-"; > + > +It is *strongly* recommended that 5200B device trees follow this convention > +(instead of only listing the base mpc5200 item). > + > +ie. ethernet on mpc5200: compatible = "fsl,mpc5200-ethernet"; > +ethernet on mpc5200b: compatible = "fsl,mpc5200b-ethernet", > + "fsl,mpc5200-ethernet"; > + > +Modal devices, like PSCs, also append the configured function to the > +end of the compatible field. ie. A PSC in i2s mode would specify > +"fsl,mpc5200-psc-i2s", not "fsl,mpc5200-i2s". This convention is chosen to > +avoid naming conflicts with non-psc devices providing the same > +function. For example, "fsl,mpc5200-spi" and "fsl,mpc5200-psc-spi" describe > +the mpc5200 simple spi device and a PSC spi mode respectively. > + > +At the time of writing, exact chip may be either 'fsl,mpc5200' or > +'fsl,mpc5200b'. > + > +The soc node > + > +This node describes the on chip SOC peripherals. Every mpc5200 based > +board will have this node, and as such there is a common naming > +convention for SOC devices. > + > +Required properties: > +name description > + --- > +ranges Memory range of the internal memory mapped > registers. > + Should be <0 [baseaddr] 0xc000> > +reg Should be <[baseaddr] 0x100> > +compatible mpc5200: "fsl,mpc5200-immr" > + mpc5200b: "fsl,mpc5200b-immr" > +system-frequency Fsystem frequency; source of all Fsystem? Typo? The unit would be nice here, too, I think. > + other clocks. > +bus-frequencyIPB bus frequency in HZ. Clock rate > + used by most of the soc devices. > + > +soc child nodes > +--- > +Any on chip SOC devices available to Linux must appear as soc5200 child > nodes. > + > +Note: The tables below show the value for the mpc5200. A mpc5200b device > +tree should use the "fsl,mpc5200b-","fsl,mpc5200-" form. > + > +Required soc5200 child nodes: > +name compatible Description > + -- --- > +cdm@ fsl,mpc5200-cmd Clock Distribution ^^ cdm! > +interrupt-controller@ fsl,mpc5200-pic need an interrupt > + controller to boot > +bestcomm@ fsl,mpc5200-bestcommBestcomm DMA > controller > + > +Recommended soc5200 child
[PATCH 1/8] powerpc/5200: update device tree binding documentation
From: Grant Likely This patch updates the mpc5200 binding documentation to match actual usage conventions, to remove incorrect information, and to remove topics which are more thoroughly described elsewhere. Signed-off-by: Grant Likely CC: devtree-disc...@ozlabs.org CC: Wolfram Sang --- Documentation/powerpc/dts-bindings/fsl/mpc5200.txt | 181 + .../powerpc/mpc52xx-device-tree-bindings.txt | 277 2 files changed, 181 insertions(+), 277 deletions(-) create mode 100644 Documentation/powerpc/dts-bindings/fsl/mpc5200.txt delete mode 100644 Documentation/powerpc/mpc52xx-device-tree-bindings.txt diff --git a/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt new file mode 100644 index 000..1eddda7 --- /dev/null +++ b/Documentation/powerpc/dts-bindings/fsl/mpc5200.txt @@ -0,0 +1,181 @@ +MPC5200 Device Tree Bindings + + +(c) 2006-2009 Secret Lab Technologies Ltd +Grant Likely + +Naming conventions +-- +For mpc5200 on-chip devices, the format for each compatible value is +-[-]. The OS should be able to match a device driver +to the device based solely on the compatible value. If two drivers +match on the compatible list; the 'most compatible' driver should be +selected. + +The split between the MPC5200 and the MPC5200B leaves a bit of a +conundrum. How should the compatible property be set up to provide +maximum compatibility information; but still accurately describe the +chip? For the MPC5200; the answer is easy. Most of the SoC devices +originally appeared on the MPC5200. Since they didn't exist anywhere +else; the 5200 compatible properties will contain only one item; +"fsl,mpc5200-". + +The 5200B is almost the same as the 5200, but not quite. It fixes +silicon bugs and it adds a small number of enhancements. Most of the +devices either provide exactly the same interface as on the 5200. A few +devices have extra functions but still have a backwards compatible mode. +To express this information as completely as possible, 5200B device trees +should have two items in the compatible list: + compatible = "fsl,mpc5200b-","fsl,mpc5200-"; + +It is *strongly* recommended that 5200B device trees follow this convention +(instead of only listing the base mpc5200 item). + +ie. ethernet on mpc5200: compatible = "fsl,mpc5200-ethernet"; +ethernet on mpc5200b: compatible = "fsl,mpc5200b-ethernet", + "fsl,mpc5200-ethernet"; + +Modal devices, like PSCs, also append the configured function to the +end of the compatible field. ie. A PSC in i2s mode would specify +"fsl,mpc5200-psc-i2s", not "fsl,mpc5200-i2s". This convention is chosen to +avoid naming conflicts with non-psc devices providing the same +function. For example, "fsl,mpc5200-spi" and "fsl,mpc5200-psc-spi" describe +the mpc5200 simple spi device and a PSC spi mode respectively. + +At the time of writing, exact chip may be either 'fsl,mpc5200' or +'fsl,mpc5200b'. + +The soc node + +This node describes the on chip SOC peripherals. Every mpc5200 based +board will have this node, and as such there is a common naming +convention for SOC devices. + +Required properties: +name description + --- +ranges Memory range of the internal memory mapped registers. + Should be <0 [baseaddr] 0xc000> +regShould be <[baseaddr] 0x100> +compatible mpc5200: "fsl,mpc5200-immr" + mpc5200b: "fsl,mpc5200b-immr" +system-frequency Fsystem frequency; source of all + other clocks. +bus-frequency IPB bus frequency in HZ. Clock rate + used by most of the soc devices. + +soc child nodes +--- +Any on chip SOC devices available to Linux must appear as soc5200 child nodes. + +Note: The tables below show the value for the mpc5200. A mpc5200b device +tree should use the "fsl,mpc5200b-","fsl,mpc5200-" form. + +Required soc5200 child nodes: +name compatible Description + -- --- +cdm@ fsl,mpc5200-cmd Clock Distribution +interrupt-controller@fsl,mpc5200-pic need an interrupt + controller to boot +bestcomm@fsl,mpc5200-bestcommBestcomm DMA controller + +Recommended soc5200 child nodes; populate as needed for your board +name compatible Description + -- --- +timer@ fsl,mpc5200-gpt General purpose timers +gpio@fsl,mpc5200-gpio MPC5200 simple gpio controller +gpio@fsl,mpc5200-gpio-wkupMPC5200 wakeup gpio controller +rtc@ fsl,mpc5200-rtc Real time clock +mscan@
