diff mbox

arm: dts: nes: add Nintendo NES Classic Edition support

Message ID 20180307164336.32359-1-miquel.raynal@bootlin.com
State New, archived
Headers show

Commit Message

Miquel Raynal March 7, 2018, 4:43 p.m. UTC
The Nintendo NES Classic features an R16 already well supported in
mainline.

The console over UART0 may be wired on two ports of the R16, both
available on the NES Classic PCB.

USB host can be used after a bit of soldering to wire a 5V power supply
directly on the PCB, in order to free the micro-USB port from that task
and allow the plug of any USB device.

Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 arch/arm/boot/dts/Makefile                         |  1 +
 arch/arm/boot/dts/sun8i-a23-a33.dtsi               | 18 ++++++
 .../dts/sun8i-r16-nintendo-nes-classic-edition.dts | 71 ++++++++++++++++++++++
 3 files changed, 90 insertions(+)
 create mode 100644 arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts

Comments

Maxime Ripard March 9, 2018, 8:26 a.m. UTC | #1
Hi Miquel,

On Wed, Mar 07, 2018 at 05:43:36PM +0100, Miquel Raynal wrote:
> The Nintendo NES Classic features an R16 already well supported in
> mainline.
> 
> The console over UART0 may be wired on two ports of the R16, both
> available on the NES Classic PCB.
> 
> USB host can be used after a bit of soldering to wire a 5V power supply
> directly on the PCB, in order to free the micro-USB port from that task
> and allow the plug of any USB device.
> 
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> ---
>  arch/arm/boot/dts/Makefile                         |  1 +
>  arch/arm/boot/dts/sun8i-a23-a33.dtsi               | 18 ++++++
>  .../dts/sun8i-r16-nintendo-nes-classic-edition.dts | 71 ++++++++++++++++++++++
>  3 files changed, 90 insertions(+)
>  create mode 100644 arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> 
> diff --git a/arch/arm/boot/dts/Makefile b/arch/arm/boot/dts/Makefile
> index ade7a38543dc..eed4e1222897 100644
> --- a/arch/arm/boot/dts/Makefile
> +++ b/arch/arm/boot/dts/Makefile
> @@ -990,6 +990,7 @@ dtb-$(CONFIG_MACH_SUN8I) += \
>  	sun8i-h3-orangepi-plus.dtb \
>  	sun8i-h3-orangepi-plus2e.dtb \
>  	sun8i-r16-bananapi-m2m.dtb \
> +	sun8i-r16-nintendo-nes-classic-edition.dtb \
>  	sun8i-r16-parrot.dtb \
>  	sun8i-r40-bananapi-m2-ultra.dtb \
>  	sun8i-v3s-licheepi-zero.dtb \
> diff --git a/arch/arm/boot/dts/sun8i-a23-a33.dtsi b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> index 971f9be699a7..1ad7291581be 100644
> --- a/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> +++ b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> @@ -315,6 +315,24 @@
>  				bias-pull-up;
>  			};
>  
> +			nand_pins_a: nand-base0@0 {
> +				pins = "PC0", "PC1", "PC2",
> +				       "PC5", "PC8", "PC9", "PC10",
> +				       "PC11", "PC12", "PC13", "PC14",
> +				       "PC15";
> +				function = "nand0";
> +			};
> +
> +			nand_cs0_pins_a: nand-cs@0 {
> +				pins = "PC4";
> +				function = "nand0";
> +			};
> +
> +			nand_rb0_pins_a: nand-rb@0 {
> +				pins = "PC6";
> +				function = "nand0";
> +			};
> +

This should be in a separate patch.

Also, these will generate dtc warnings.

If there is multiple muxing options, I'd suggest to have the node
names be nand-pc-pins, and the label nand_pc_pins. If there's only
one, you can drop the pc part.

>  			pwm0_pins: pwm0 {
>  				pins = "PH0";
>  				function = "pwm0";
> diff --git a/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> new file mode 100644
> index 000000000000..63c289f1f46d
> --- /dev/null
> +++ b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> @@ -0,0 +1,71 @@
> +// SPDX-License-Identifier: GPL-2.0 OR X11
> +/* Copyright (c) 2016 FUKAUMI Naoki <naobsd@gmail.com> */
> +
> +/dts-v1/;
> +#include "sun8i-a33.dtsi"
> +#include "sunxi-common-regulators.dtsi"
> +
> +/ {
> +	model = "Nintendo NES Classic Edition";
> +	compatible = "nintendo,nes-classic-edition", "allwinner,sun8i-a33";
> +
> +	aliases {
> +		serial0 = &uart0;
> +	};
> +
> +	chosen {
> +		stdout-path = "serial0:115200n8";
> +	};
> +};
> +
> +&uart0 {
> +	/*
> +	 * UART0 is available on two ports, both accessible on the NES Classic
> +	 * PCB. One can use the <&uart0_pins_b> handle instead.
> +	 */

I guess you should mention that the PF pins will also rule out the SD
option that might be convenient.

> +	pinctrl-names = "default";
> +	pinctrl-0 = <&uart0_pins_a>;
> +	status = "okay";
> +};
> +
> +&nfc {
> +	pinctrl-names = "default";
> +	pinctrl-0 = <&nand_pins_a &nand_cs0_pins_a &nand_rb0_pins_a>;
> +	status = "okay";
> +
> +	/* 2Gb Macronix MX30LF2G18AC (3V) */
> +	nand@0 {
> +		#address-cells = <1>;
> +		#size-cells = <1>;
> +		reg = <0>;
> +		allwinner,rb = <0>;
> +		nand-ecc-mode = "hw";
> +		nand-ecc-strength = <16>;
> +		nand-ecc-step-size = <1024>;
> +	};
> +};
> +
> +/*
> + * The NES is powered by the USB port. However it is possible to solder a wire
> + * from the internal side of the connector on VBUS pin to supply the required 5V
> + * without the need of a cable plugged in the micro USB port. This way it is
> + * easy to use any USB device.
> + */
> +&usb_otg {
> +	dr_mode = "host";
> +	status = "okay";
> +};

We want to support the default setup, and not require some hackery to
be done. It will thus be some OTG / peripheral mode, most likely with
an ID pin somewhere.

Since you tested on a SuperNES Classic, I think you should also create
a new DT (possibly include it) with a compatible of its own.

That way, if we ever find some differences, it will be easy to deal
with them.

Maxime
Miquel Raynal March 9, 2018, 8:58 a.m. UTC | #2
Hi Maxime,

On Fri, 9 Mar 2018 09:26:56 +0100, Maxime Ripard
<maxime.ripard@bootlin.com> wrote:

> Hi Miquel,
> 
> On Wed, Mar 07, 2018 at 05:43:36PM +0100, Miquel Raynal wrote:
> > The Nintendo NES Classic features an R16 already well supported in
> > mainline.
> > 
> > The console over UART0 may be wired on two ports of the R16, both
> > available on the NES Classic PCB.
> > 
> > USB host can be used after a bit of soldering to wire a 5V power supply
> > directly on the PCB, in order to free the micro-USB port from that task
> > and allow the plug of any USB device.
> > 
> > Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> > ---
> >  arch/arm/boot/dts/Makefile                         |  1 +
> >  arch/arm/boot/dts/sun8i-a23-a33.dtsi               | 18 ++++++
> >  .../dts/sun8i-r16-nintendo-nes-classic-edition.dts | 71 ++++++++++++++++++++++
> >  3 files changed, 90 insertions(+)
> >  create mode 100644 arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> > 
> > diff --git a/arch/arm/boot/dts/Makefile b/arch/arm/boot/dts/Makefile
> > index ade7a38543dc..eed4e1222897 100644
> > --- a/arch/arm/boot/dts/Makefile
> > +++ b/arch/arm/boot/dts/Makefile
> > @@ -990,6 +990,7 @@ dtb-$(CONFIG_MACH_SUN8I) += \
> >  	sun8i-h3-orangepi-plus.dtb \
> >  	sun8i-h3-orangepi-plus2e.dtb \
> >  	sun8i-r16-bananapi-m2m.dtb \
> > +	sun8i-r16-nintendo-nes-classic-edition.dtb \
> >  	sun8i-r16-parrot.dtb \
> >  	sun8i-r40-bananapi-m2-ultra.dtb \
> >  	sun8i-v3s-licheepi-zero.dtb \
> > diff --git a/arch/arm/boot/dts/sun8i-a23-a33.dtsi b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> > index 971f9be699a7..1ad7291581be 100644
> > --- a/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> > +++ b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
> > @@ -315,6 +315,24 @@
> >  				bias-pull-up;
> >  			};
> >  
> > +			nand_pins_a: nand-base0@0 {
> > +				pins = "PC0", "PC1", "PC2",
> > +				       "PC5", "PC8", "PC9", "PC10",
> > +				       "PC11", "PC12", "PC13", "PC14",
> > +				       "PC15";

I will change a bit the visual organization.

> > +				function = "nand0";
> > +			};
> > +
> > +			nand_cs0_pins_a: nand-cs@0 {
> > +				pins = "PC4";
> > +				function = "nand0";
> > +			};
> > +
> > +			nand_rb0_pins_a: nand-rb@0 {
> > +				pins = "PC6";
> > +				function = "nand0";
> > +			};
> > +  
> 
> This should be in a separate patch.

Ok.

> 
> Also, these will generate dtc warnings.

I will remove the trailing @0.

> 
> If there is multiple muxing options, I'd suggest to have the node
> names be nand-pc-pins, and the label nand_pc_pins. If there's only
> one, you can drop the pc part.

There is only one, I will name it nand_pins: nand-pins.

For CS and RB pins, there are two of them each time, I will declare
them all:
nand_pins_cs0 PC4
nand_pins_cs1 PC3
nand_pins_rb0 PC6
nand_pins_rb1 PC7

> 
> >  			pwm0_pins: pwm0 {
> >  				pins = "PH0";
> >  				function = "pwm0";
> > diff --git a/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> > new file mode 100644
> > index 000000000000..63c289f1f46d
> > --- /dev/null
> > +++ b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
> > @@ -0,0 +1,71 @@
> > +// SPDX-License-Identifier: GPL-2.0 OR X11
> > +/* Copyright (c) 2016 FUKAUMI Naoki <naobsd@gmail.com> */
> > +
> > +/dts-v1/;
> > +#include "sun8i-a33.dtsi"
> > +#include "sunxi-common-regulators.dtsi"
> > +
> > +/ {
> > +	model = "Nintendo NES Classic Edition";
> > +	compatible = "nintendo,nes-classic-edition", "allwinner,sun8i-a33";
> > +
> > +	aliases {
> > +		serial0 = &uart0;
> > +	};
> > +
> > +	chosen {
> > +		stdout-path = "serial0:115200n8";
> > +	};
> > +};
> > +
> > +&uart0 {
> > +	/*
> > +	 * UART0 is available on two ports, both accessible on the NES Classic
> > +	 * PCB. One can use the <&uart0_pins_b> handle instead.
> > +	 */  
> 
> I guess you should mention that the PF pins will also rule out the SD
> option that might be convenient.

Sure. I will add that port PB and PF can both mux UART0, but PF can
also be used for the SD card, so PB is preferred (
> 
> > +	pinctrl-names = "default";
> > +	pinctrl-0 = <&uart0_pins_a>;
> > +	status = "okay";
> > +};
> > +
> > +&nfc {
> > +	pinctrl-names = "default";
> > +	pinctrl-0 = <&nand_pins_a &nand_cs0_pins_a &nand_rb0_pins_a>;

I'll move this in the DTSI also.

> > +	status = "okay";
> > +
> > +	/* 2Gb Macronix MX30LF2G18AC (3V) */
> > +	nand@0 {
> > +		#address-cells = <1>;
> > +		#size-cells = <1>;
> > +		reg = <0>;
> > +		allwinner,rb = <0>;
> > +		nand-ecc-mode = "hw";
> > +		nand-ecc-strength = <16>;
> > +		nand-ecc-step-size = <1024>;
> > +	};
> > +};
> > +
> > +/*
> > + * The NES is powered by the USB port. However it is possible to solder a wire
> > + * from the internal side of the connector on VBUS pin to supply the required 5V
> > + * without the need of a cable plugged in the micro USB port. This way it is
> > + * easy to use any USB device.
> > + */
> > +&usb_otg {
> > +	dr_mode = "host";
> > +	status = "okay";
> > +};  
> 
> We want to support the default setup, and not require some hackery to
> be done. It will thus be some OTG / peripheral mode, most likely with
> an ID pin somewhere.
> 
> Since you tested on a SuperNES Classic, I think you should also create
> a new DT (possibly include it) with a compatible of its own.
> 
> That way, if we ever find some differences, it will be easy to deal
> with them.

So, what you would prefer is:
1/ Move this entire DTS but the usb_otg node into a
"sun8i-r16-nintendo-nes.dtsi"
2/ Include that DTSI from a
"sun8i-r16-nintendo-super-nes-classic-edition.dts" that would add the
usb_otg node as it is above.

Right?

Thanks,
Miquèl
Maxime Ripard March 9, 2018, 9:10 a.m. UTC | #3
On Fri, Mar 09, 2018 at 09:58:14AM +0100, Miquel Raynal wrote:
> > Since you tested on a SuperNES Classic, I think you should also create
> > a new DT (possibly include it) with a compatible of its own.
> > 
> > That way, if we ever find some differences, it will be easy to deal
> > with them.
> 
> So, what you would prefer is:
> 1/ Move this entire DTS but the usb_otg node into a
> "sun8i-r16-nintendo-nes.dtsi"
> 2/ Include that DTSI from a
> "sun8i-r16-nintendo-super-nes-classic-edition.dts" that would add the
> usb_otg node as it is above.

My remark had nothing to do with USB OTG. You can just create a DT
called sun8i-r16-nintendo-nes-classic.dts, and then create another one
call sun8i-r16-nintendo-supernes-classic.dts that would include the
former, only overriding the compatible.

Maxime
Miquel Raynal March 9, 2018, 9:34 a.m. UTC | #4
Hi Maxime,

> > > We want to support the default setup, and not require some hackery to
> > > be done. It will thus be some OTG / peripheral mode, most likely with
> > > an ID pin somewhere.

I would really appreciate to let the comment because with this kind of
boards, almost everything is hackery. Think about the SD card support.
Pins are there, but nothing is wired on it. However we still want to
let these pins available for it.

I can drop the mode = "host" property though.

> On Fri, Mar 09, 2018 at 09:58:14AM +0100, Miquel Raynal wrote:
> > > Since you tested on a SuperNES Classic, I think you should also create
> > > a new DT (possibly include it) with a compatible of its own.
> > > 
> > > That way, if we ever find some differences, it will be easy to deal
> > > with them.  
> > 
> > So, what you would prefer is:
> > 1/ Move this entire DTS but the usb_otg node into a
> > "sun8i-r16-nintendo-nes.dtsi"
> > 2/ Include that DTSI from a
> > "sun8i-r16-nintendo-super-nes-classic-edition.dts" that would add the
> > usb_otg node as it is above.  
> 
> My remark had nothing to do with USB OTG.

OK, sorry.

> You can just create a DT
> called sun8i-r16-nintendo-nes-classic.dts, and then create another one
> call sun8i-r16-nintendo-supernes-classic.dts that would include the
> former, only overriding the compatible.

And being almost empty then?

> 
> Maxime
>
Maxime Ripard March 9, 2018, 10:09 a.m. UTC | #5
On Fri, Mar 09, 2018 at 10:34:53AM +0100, Miquel Raynal wrote:
> > > > We want to support the default setup, and not require some hackery to
> > > > be done. It will thus be some OTG / peripheral mode, most likely with
> > > > an ID pin somewhere.
> 
> I would really appreciate to let the comment because with this kind of
> boards, almost everything is hackery. Think about the SD card support.
> Pins are there, but nothing is wired on it. However we still want to
> let these pins available for it.

I disagree here. That kind of information in the device tree is
neither easily discoverable nor comprehensive.

The chance for a regular user to think about going to look to the
device tree for that kind of informations is leaning towards 0. And
you cannot even describe fully the modifications that need to be done
to achieve that.

These infos should belong in the wiki, with images, pictures, whatever
is needed, and not in the device tree.

> I can drop the mode = "host" property though.
> 
> > On Fri, Mar 09, 2018 at 09:58:14AM +0100, Miquel Raynal wrote:
> > > > Since you tested on a SuperNES Classic, I think you should also create
> > > > a new DT (possibly include it) with a compatible of its own.
> > > > 
> > > > That way, if we ever find some differences, it will be easy to deal
> > > > with them.  
> > > 
> > > So, what you would prefer is:
> > > 1/ Move this entire DTS but the usb_otg node into a
> > > "sun8i-r16-nintendo-nes.dtsi"
> > > 2/ Include that DTSI from a
> > > "sun8i-r16-nintendo-super-nes-classic-edition.dts" that would add the
> > > usb_otg node as it is above.  
> > 
> > My remark had nothing to do with USB OTG.
> 
> OK, sorry.
> 
> > You can just create a DT
> > called sun8i-r16-nintendo-nes-classic.dts, and then create another one
> > call sun8i-r16-nintendo-supernes-classic.dts that would include the
> > former, only overriding the compatible.
> 
> And being almost empty then?

Yep, in the best scenario. But we're also preparing for the worst :)

Maxime
diff mbox

Patch

diff --git a/arch/arm/boot/dts/Makefile b/arch/arm/boot/dts/Makefile
index ade7a38543dc..eed4e1222897 100644
--- a/arch/arm/boot/dts/Makefile
+++ b/arch/arm/boot/dts/Makefile
@@ -990,6 +990,7 @@  dtb-$(CONFIG_MACH_SUN8I) += \
 	sun8i-h3-orangepi-plus.dtb \
 	sun8i-h3-orangepi-plus2e.dtb \
 	sun8i-r16-bananapi-m2m.dtb \
+	sun8i-r16-nintendo-nes-classic-edition.dtb \
 	sun8i-r16-parrot.dtb \
 	sun8i-r40-bananapi-m2-ultra.dtb \
 	sun8i-v3s-licheepi-zero.dtb \
diff --git a/arch/arm/boot/dts/sun8i-a23-a33.dtsi b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
index 971f9be699a7..1ad7291581be 100644
--- a/arch/arm/boot/dts/sun8i-a23-a33.dtsi
+++ b/arch/arm/boot/dts/sun8i-a23-a33.dtsi
@@ -315,6 +315,24 @@ 
 				bias-pull-up;
 			};
 
+			nand_pins_a: nand-base0@0 {
+				pins = "PC0", "PC1", "PC2",
+				       "PC5", "PC8", "PC9", "PC10",
+				       "PC11", "PC12", "PC13", "PC14",
+				       "PC15";
+				function = "nand0";
+			};
+
+			nand_cs0_pins_a: nand-cs@0 {
+				pins = "PC4";
+				function = "nand0";
+			};
+
+			nand_rb0_pins_a: nand-rb@0 {
+				pins = "PC6";
+				function = "nand0";
+			};
+
 			pwm0_pins: pwm0 {
 				pins = "PH0";
 				function = "pwm0";
diff --git a/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
new file mode 100644
index 000000000000..63c289f1f46d
--- /dev/null
+++ b/arch/arm/boot/dts/sun8i-r16-nintendo-nes-classic-edition.dts
@@ -0,0 +1,71 @@ 
+// SPDX-License-Identifier: GPL-2.0 OR X11
+/* Copyright (c) 2016 FUKAUMI Naoki <naobsd@gmail.com> */
+
+/dts-v1/;
+#include "sun8i-a33.dtsi"
+#include "sunxi-common-regulators.dtsi"
+
+/ {
+	model = "Nintendo NES Classic Edition";
+	compatible = "nintendo,nes-classic-edition", "allwinner,sun8i-a33";
+
+	aliases {
+		serial0 = &uart0;
+	};
+
+	chosen {
+		stdout-path = "serial0:115200n8";
+	};
+};
+
+&uart0 {
+	/*
+	 * UART0 is available on two ports, both accessible on the NES Classic
+	 * PCB. One can use the <&uart0_pins_b> handle instead.
+	 */
+	pinctrl-names = "default";
+	pinctrl-0 = <&uart0_pins_a>;
+	status = "okay";
+};
+
+&nfc {
+	pinctrl-names = "default";
+	pinctrl-0 = <&nand_pins_a &nand_cs0_pins_a &nand_rb0_pins_a>;
+	status = "okay";
+
+	/* 2Gb Macronix MX30LF2G18AC (3V) */
+	nand@0 {
+		#address-cells = <1>;
+		#size-cells = <1>;
+		reg = <0>;
+		allwinner,rb = <0>;
+		nand-ecc-mode = "hw";
+		nand-ecc-strength = <16>;
+		nand-ecc-step-size = <1024>;
+	};
+};
+
+/*
+ * The NES is powered by the USB port. However it is possible to solder a wire
+ * from the internal side of the connector on VBUS pin to supply the required 5V
+ * without the need of a cable plugged in the micro USB port. This way it is
+ * easy to use any USB device.
+ */
+&usb_otg {
+	dr_mode = "host";
+	status = "okay";
+};
+
+&usbphy {
+	/* VBUS is always on because it is wired to the power supply */
+	usb1_vbus-supply = <&reg_vcc5v0>;
+	status = "okay";
+};
+
+&ehci0 {
+	status = "okay";
+};
+
+&ohci0 {
+	status = "okay";
+};