02162129b4855da0c0b222f3ff694e7de2f4c4b3
[oweals/openwrt.git] / target / linux / brcm2708 / patches-4.19 / 950-0253-overlays-Update-README-with-removal-of-lirc-rpi.patch
1 From f2c24ce7e03d059fa9f674d8ebf6286e8f0c38b6 Mon Sep 17 00:00:00 2001
2 From: Phil Elwell <phil@raspberrypi.org>
3 Date: Wed, 5 Dec 2018 11:56:40 +0000
4 Subject: [PATCH] overlays: Update README with removal of lirc-rpi
5
6 Signed-off-by: Phil Elwell <phil@raspberrypi.org>
7 ---
8  arch/arm/boot/dts/overlays/README | 57 ++++++++++++-------------------
9  1 file changed, 21 insertions(+), 36 deletions(-)
10
11 --- a/arch/arm/boot/dts/overlays/README
12 +++ b/arch/arm/boot/dts/overlays/README
13 @@ -56,23 +56,29 @@ have its contents deleted (or commented
14  Using Overlays
15  ==============
16  
17 -Overlays are loaded using the "dtoverlay" directive. As an example, consider
18 -the popular lirc-rpi module, the Linux Infrared Remote Control driver. In the
19 -pre-DT world this would be loaded from /etc/modules, with an explicit
20 -"modprobe lirc-rpi" command, or programmatically by lircd. With DT enabled,
21 -this becomes a line in config.txt:
22 -
23 -    dtoverlay=lirc-rpi
24 -
25 -This causes the file /boot/overlays/lirc-rpi.dtbo to be loaded. By
26 -default it will use GPIOs 17 (out) and 18 (in), but this can be modified using
27 -DT parameters:
28 -
29 -    dtoverlay=lirc-rpi,gpio_out_pin=17,gpio_in_pin=13
30 -
31 -Parameters always have default values, although in some cases (e.g. "w1-gpio")
32 -it is necessary to provided multiple overlays in order to get the desired
33 -behaviour. See the list of overlays below for a description of the parameters
34 +Overlays are loaded using the "dtoverlay" config.txt setting. As an example,
35 +consider I2C Real Time Clock drivers. In the pre-DT world these would be loaded
36 +by writing a magic string comprising a device identifier and an I2C address to
37 +a special file in /sys/class/i2c-adapter, having first loaded the driver for
38 +the I2C interface and the RTC device - something like this:
39 +
40 +    modprobe i2c-bcm2835
41 +    modprobe rtc-ds1307
42 +    echo ds1307 0x68 > /sys/class/i2c-adapter/i2c-1/new_device
43 +
44 +With DT enabled, this becomes a line in config.txt:
45 +
46 +    dtoverlay=i2c-rtc,ds1307
47 +
48 +This causes the file /boot/overlays/i2c-rtc.dtbo to be loaded and a "node"
49 +describing the DS1307 I2C device to be added to the Device Tree for the Pi. By
50 +default it usees address 0x68, but this can be modified with an additional DT
51 +parameter:
52 +
53 +    dtoverlay=i2c-rtc,ds1307,addr=0x68
54 +
55 +Parameters usually have default values, although certain parameters are
56 +mandatory. See the list of overlays below for a description of the parameters
57  and their defaults.
58  
59  The Overlay and Parameter Reference
60 @@ -1135,29 +1141,8 @@ Params: <None>
61  
62  
63  Name:   lirc-rpi
64 -Info:   Configures lirc-rpi (Linux Infrared Remote Control for Raspberry Pi)
65 -        Consult the module documentation for more details.
66 -Load:   dtoverlay=lirc-rpi,<param>=<val>
67 -Params: gpio_out_pin            GPIO for output (default "17")
68 -
69 -        gpio_in_pin             GPIO for input (default "18")
70 -
71 -        gpio_in_pull            Pull up/down/off on the input pin
72 -                                (default "down")
73 -
74 -        sense                   Override the IR receive auto-detection logic:
75 -                                 "0" = force active-high
76 -                                 "1" = force active-low
77 -                                 "-1" = use auto-detection
78 -                                (default "-1")
79 -
80 -        softcarrier             Turn the software carrier "on" or "off"
81 -                                (default "on")
82 -
83 -        invert                  "on" = invert the output pin (default "off")
84 -
85 -        debug                   "on" = enable additional debug messages
86 -                                (default "off")
87 +Info:   This overlay has been deprecated and removed - see gpio-ir
88 +Load:   <Deprecated>
89  
90  
91  Name:   ltc294x