Skip to content

Commit 3e52add

Browse files
fhunlethmobileoverlord
authored andcommitted
WIP kernel documentation
1 parent ab08a3b commit 3e52add

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

docs/kernel.md

+66
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,8 @@ CONFIG_NLS_UTF8=y
101101

102102
## ElixirALE
103103

104+
I2C, SPI, and GPIO support in user-land.
105+
104106
```config
105107
CONFIG_GPIO_SYSFS=y
106108
CONFIG_I2C_CHARDEV=y
@@ -111,6 +113,9 @@ CONFIG_SPI_SPIDEV=y
111113

112114
## Watchdog
113115

116+
Nerves updated Erlang's heart process to pet the hardware watchdog. This
117+
provides an additional level of protection against VM (or other) hangs.
118+
114119
```config
115120
CONFIG_WATCHDOG=y
116121
CONFIG_WATCHDOG_NOWAYOUT=y
@@ -120,6 +125,8 @@ CONFIG_OMAP_WATCHDOG=y
120125

121126
## nerves_led
122127

128+
This is needed by [nerves_leds](https://github.com/nerves-project/nerves_leds/)
129+
123130
```config
124131
CONFIG_NEW_LEDS=y
125132
CONFIG_LEDS_CLASS=y
@@ -141,6 +148,9 @@ CONFIG_LEDS_TRIGGER_TRANSIENT=y
141148

142149
## Ethernet
143150

151+
Most of the Beaglebones have a wired network interface. This enables both it and
152+
its PHY driver.
153+
144154
```config
145155
CONFIG_NETDEVICES=y
146156
# CONFIG_NET_VENDOR_ARC is not set
@@ -192,16 +202,59 @@ CONFIG_WL_TI=y
192202
CONFIG_WL12XX=m
193203
CONFIG_WL18XX=m
194204
CONFIG_WLCORE_SDIO=m
205+
CONFIG_STAGING=y
206+
CONFIG_R8712U=m
195207
```
196208

197209
## AM335x ADCs
198210

199211
```config
212+
CONFIG_MFD_TI_AM335X_TSCADC=y
213+
CONFIG_IIO=y
214+
CONFIG_TI_AM335X_ADC=y
215+
```
200216

217+
### Power and thermal
218+
219+
```config
220+
CONFIG_POWER_AVS=y
221+
CONFIG_POWER_RESET=y
222+
CONFIG_POWER_RESET_GPIO=y
223+
CONFIG_POWER_RESET_GPIO_RESTART=y
224+
CONFIG_POWER_RESET_RESTART=y
225+
CONFIG_POWER_RESET_SYSCON=y
226+
CONFIG_POWER_RESET_SYSCON_POWEROFF=y
227+
CONFIG_THERMAL=y
228+
CONFIG_THERMAL_GOV_FAIR_SHARE=y
229+
CONFIG_THERMAL_GOV_BANG_BANG=y
230+
CONFIG_CPU_THERMAL=y
231+
CONFIG_CLOCK_THERMAL=y
232+
CONFIG_TI_SOC_THERMAL=y
233+
CONFIG_TI_THERMAL=y
234+
CONFIG_REGULATOR_GPIO=y
235+
CONFIG_REGULATOR_PBIAS=y
236+
CONFIG_REGULATOR_TI_ABB=y
237+
CONFIG_REGULATOR_TPS65217=y
238+
```
239+
240+
### PWM
241+
242+
The AM335x parts have some interesting PWM capabilities.
243+
244+
```config
245+
CONFIG_PWM=y
246+
CONFIG_PWM_OMAP_DMTIMER=y
247+
CONFIG_PWM_TIECAP=y
248+
CONFIG_PWM_TIEHRPWM=y
201249
```
202250

203251
## USB
204252

253+
The Beaglebones have both a host-only USB interface and a on-the-go (host or
254+
gadget) USB interface. The latter interface is used in the default image to
255+
provide network and console access. This makes it really easy for beginners to
256+
use PocketBeagles and the like since they only need one cable.
257+
205258
```config
206259
CONFIG_USB=y
207260
CONFIG_USB_ANNOUNCE_NEW_DEVICES=y
@@ -223,6 +276,19 @@ CONFIG_USB_CDC_COMPOSITE=y
223276

224277
## Serial ports
225278

279+
Depending on the device tree setup, there can be 6 UARTs.
280+
281+
```config
282+
# CONFIG_LEGACY_PTYS is not set
283+
CONFIG_SERIAL_8250=y
284+
# CONFIG_SERIAL_8250_DEPRECATED_OPTIONS is not set
285+
CONFIG_SERIAL_8250_CONSOLE=y
286+
CONFIG_SERIAL_8250_NR_UARTS=6
287+
CONFIG_SERIAL_8250_RUNTIME_UARTS=6
288+
CONFIG_SERIAL_8250_OMAP=y
289+
CONFIG_SERIAL_OF_PLATFORM=y
290+
```
291+
226292
## Remote control support
227293

228294
Linux has IR remote control support enabled by default, but this is probably not

0 commit comments

Comments
 (0)