Skip to content

Commit 42c1b86

Browse files
committed
Fix a bunch of broken links
1 parent ae1f98a commit 42c1b86

7 files changed

Lines changed: 54 additions & 29 deletions

File tree

_data/ports.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,21 +184,21 @@
184184
"id": "EV3_OUTPUT_PORT_MODE_TACHO_MOTOR",
185185
"name": "tacho-motor",
186186
"name_footnote": "[^tacho-motor-mode]",
187-
"notes": "\n[^tacho-motor-mode]: Configures the port to use the\n [tacho-motor] driver module. The default driver is the\n EV3 Large Motor (`lego-ev3-l-motor`). You can change\n the driver using the `set_device` attribute.\n ^\n [tacho-motor]: /docs/drivers/tacho-motor\n \n "
187+
"notes": "\n[^tacho-motor-mode]: Configures the port to use the\n [tacho-motor] driver module. The default driver is the\n EV3 Large Motor (`lego-ev3-l-motor`). You can change\n the driver using the `set_device` attribute.\n ^\n [tacho-motor]: /docs/drivers/tacho-motor-class\n \n "
188188
},
189189
{
190190
"description": "Load the [dc-motor] device.",
191191
"id": "EV3_OUTPUT_PORT_MODE_DC_MOTOR",
192192
"name": "dc-motor",
193193
"name_footnote": "[^dc-motor-mode]",
194-
"notes": "\n[^dc-motor-mode]: This can be use with MINDSTORMS RCX\n motors, Power Functions motors and any other 'plain' DC\n motor. By 'plain', we mean the motor is just a motor without\n any feedback.\n ^\n [dc-motor]: /docs/drivers/dc-motor\n \n "
194+
"notes": "\n[^dc-motor-mode]: This can be use with MINDSTORMS RCX\n motors, Power Functions motors and any other 'plain' DC\n motor. By 'plain', we mean the motor is just a motor without\n any feedback.\n ^\n [dc-motor]: /docs/drivers/dc-motor-class\n \n "
195195
},
196196
{
197197
"description": "Load the [led] device.",
198198
"id": "EV3_OUTPUT_PORT_MODE_LED",
199199
"name": "led",
200200
"name_footnote": "[^led-mode]",
201-
"notes": "\n[^led-mode]: This can be used with MINDSTORMS RCX LEDs,\n Power Functions LEDs or any other LED connected to pins 1\n and 2 of the output port.\n ^\n [led]: /docs/drivers/led\n \n "
201+
"notes": "\n[^led-mode]: This can be used with MINDSTORMS RCX LEDs,\n Power Functions LEDs or any other LED connected to pins 1\n and 2 of the output port.\n ^\n [led]: /docs/drivers/rcx-led\n \n "
202202
},
203203
{
204204
"description": "Provide access to low level drivers.",

docs/drivers/brickpi-i2c-sensor.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Devices bound to this driver can be found in the directory
2020
the [lego-sensor class] which is where the useful stuff is. Follow the link
2121
for more information.
2222

23-
[brickpi]: /docs/drivers/brickpi
23+
[brickpi]: /docs/drivers/brickpi-ld
2424
[brickpi-in-port]: /docs/ports/brickpi-port
2525
[list of supported sensors]: /docs/sensors#supported-sensors
2626
[lego-sensor class]: ../lego-sensor-class

docs/kernel-hackers-notebook/ev3-i2c.md

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,42 @@
22
title: EV3 I2C
33
---
44

5-
The [AM1808 SoC](ev3-processor) has 2 hardware [Inter-Integrated Circuit](https://en.wikipedia.org/wiki/I2c) (I2C) controllers. Additionally, there are 4 software controllers implemented using [fast interrupts](../ev3-fiq) (FIQs).
5+
The [AM1808 SoC](../ev3-processor) has 2 hardware [Inter-Integrated Circuit][i2c]
6+
(I2C) controllers. Additionally, there are 4 software controllers implemented using
7+
[fast interrupts](../ev3-fiq) (FIQs).
68

79
## Usage
810

911
__I2C0__: [Boot EEPROM](../ev3-eeprom) @400kHz
1012

1113
__I2C1__: Not used/connected
1214

13-
__[FIQ](ev3-fiq) I2C__: Input ports 1-4 @10kHz
15+
__[FIQ](../ev3-fiq) I2C__: Input ports 1-4 @10kHz
1416

1517
## Device Drivers
1618

17-
The Linux kernel has a well established [framework for I2C drivers](https://www.kernel.org/doc/Documentation/i2c/).
19+
The Linux kernel has a well established [framework for I2C drivers].
1820

19-
The SoC I2C uses the existing driver at [drivers/i2c/busses/i2c-davinci.c](https://github.com/ev3dev/ev3dev-kernel/blob/master/drivers/i2c/busses/i2c-davinci.c) as a backend.
21+
The SoC I2C uses the existing driver at [drivers/i2c/busses/i2c-davinci.c] as a backend.
2022

21-
Since there are not enough I2C controllers on the SoC, LEGO chose to implement the I2C buses for the four input ports using GPIOs. A secondary reason for this is that the NXT Ultrasonic sensors does not work well with standard I2C masters. It requires an extra clock pulse between the stop and the next start. (TODO: add references here.)
23+
Since there are not enough I2C controllers on the SoC, LEGO chose to implement
24+
the I2C buses for the four input ports using GPIOs. A secondary reason for this
25+
is that the NXT Ultrasonic sensors does not work well with standard I2C masters.
26+
It requires an extra clock pulse between the stop and the next start. (TODO: add
27+
references here.)
2228

23-
This Linux kernel has an existing GPIO i2c driver, but in order to get the performance needed, we have to use [fast interrupts](EV3 FIQ) (FIQs). (Be sure to follow the link for some interesting reading.) So, the really low level stuff is done in [arch/arm/mach-davinci/legoev3-fiq.c](https://github.com/ev3dev/ev3dev-kernel/blob/master/arch/arm/mach-davinci/legoev3-fiq.c) and the rest is in [drivers/i2c/busses/i2c-legoev3.c](https://github.com/ev3dev/ev3dev-kernel/blob/master/drivers/i2c/busses/i2c-legoev3.c).
29+
This Linux kernel has an existing GPIO i2c driver, but in order to get the
30+
performance needed, we have to use [fast interrupts](../ev3-fiq) (FIQs). (Be sure
31+
to follow the link for some interesting reading.) So, the really low level stuff
32+
is done in [arch/arm/mach-davinci/legoev3-fiq.c] and the rest is in
33+
[drivers/i2c/busses/i2c-legoev3.c].
2434

2535
## I2C Addressing
2636

27-
See [I2C Sensor Addressing]({{ github.site.url }}/docs/sensors/i2c-sensor-addressing/).
37+
See [I2C Sensor Addressing](/docs/sensors/i2c-sensor-addressing/).
38+
39+
[i2c]: https://en.wikipedia.org/wiki/I2c
40+
[framework for I2C drivers]: https://www.kernel.org/doc/Documentation/i2c/
41+
[drivers/i2c/busses/i2c-davinci.c]: https://github.com/ev3dev/ev3-kernel/blob/ev3dev-jessie/drivers/i2c/busses/i2c-davinci.c
42+
[arch/arm/mach-davinci/legoev3-fiq.c]: https://github.com/ev3dev/ev3-kernel/blob/ev3dev-jessie/arch/arm/mach-davinci/legoev3-fiq.c
43+
[drivers/i2c/busses/i2c-legoev3.c]: https://github.com/ev3dev/lego-linux-drivers/blob/master/ev3/legoev3_i2c.c

docs/kernel-hackers-notebook/ev3-uart.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
title: EV3 UART
33
---
44

5-
The [AM1808 SoC](../ev3-processor) has 3 hardware [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter) controllers. We are also using the [PRU](../ev3-pru) to provide 2 additional software UARTs.
5+
The [AM1808 SoC](../ev3-processor) has 3 hardware [UART] controllers. We are
6+
also using the [PRU](../ev3-pru) to provide 2 additional software UARTs.
67

78
## Usage
89

@@ -19,9 +20,22 @@ __PRU0/SUART1__ | Input port 3 UART sensors.
1920

2021
See the [PRU](../ev3-pru) page for info on the PRU UART drivers.
2122

22-
The SoC UARTs are standard UARTs and therefore use the [8250](https://github.com/ev3dev/ev3dev-kernel/tree/uart-sensors/drivers/tty/serial/8250) driver. Both types of UARTs (SoC and PRU) of course implement the [tty](https://github.com/ev3dev/ev3dev-kernel/tree/uart-sensors/drivers/tty) device class. The interesting part is the LEGOEV3 [line discipline](https://github.com/ev3dev/ev3dev-kernel/blob/uart-sensors/Documentation/serial/tty.txt) that runs on top of the tty driver.
23+
The SoC UARTs are standard UARTs and therefore use the
24+
[8250](https://github.com/ev3dev/ev3-kernel/tree/ev3dev-jessie/drivers/tty/serial/8250)
25+
driver. Both types of UARTs (SoC and PRU) of course implement the
26+
[tty](https://github.com/ev3dev/ev3-kernel/tree/ev3dev-jessie/drivers/tty)
27+
device class. The interesting part is the LEGOEV3 [line discipline] that runs
28+
on top of the tty driver.
2329

2430
### LEGOEV3 Line Discipline
25-
Source: [uart-sensors/drivers/legoev3/legoev3_uart.c](https://github.com/ev3dev/ev3dev-kernel/blob/uart-sensors/drivers/legoev3/legoev3_uart.c)
31+
Source: [ev3_uart_sensor_ld.c](https://github.com/ev3dev/lego-linux-drivers/blob/master/sensors/ev3_uart_sensor_ld.c)
2632

27-
There are udev rules in place ([/lib/udev/rules.d/ev3dev-uart.rules](https://github.com/ev3dev/ev3dev-base/blob/master/debian/ev3dev-uart.udev) in conjunction with [/lib/ev3dev/uart.sh](https://github.com/ev3dev/ev3dev-base/blob/master/usr/lib/ev3dev/uart.sh)) that attach the line discipline to a tty (serial port) when a UART sensor is detected on a given input port. When the sensor is removed, the line discipline is detached (process killed).
33+
There are udev rules in place ([ev3.rules] in conjunction with [ev3-uart@.service])
34+
that attach the line discipline to a tty (serial port) when a UART sensor is
35+
detected on a given input port. When the sensor is removed, the line discipline
36+
is detached (process killed).
37+
38+
[UART]: https://en.wikipedia.org/wiki/Universal_asynchronous_receiver/transmitter
39+
[line discipline]: https://github.com/ev3dev/ev3dev-kernel/blob/uart-sensors/Documentation/serial/tty.txt
40+
[ev3.rules]: https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/debian/ev3.udev#L19
41+
[ev3-uart@.service]: https://github.com/ev3dev/ev3-systemd/blob/ev3dev-jessie/systemd/ev3-uart%40.service

docs/kernel-hackers-notebook/index.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,22 +38,17 @@ the ev3dev kernel. It is mostly information about the hardware and device driver
3838

3939
### Sensors (Input Devices)
4040

41-
* [Sensor Driver Model](ev3-sensor-driver-model)
42-
* [List of Sensors](list-of-sensors)
41+
* [Sensor Driver Model](/docs/drivers/lego-sensor-class)
42+
* [List of Sensors](/docs/sensors/#supported-sensors)
4343

4444
### Motors (Output Devices)
4545

46-
* [Motor Driver Model](ev3-motor-driver-model)
47-
* [List of Motors](list-of-motors)
46+
* [Motor Driver Model](/docs/drivers/tacho-motor-class)
47+
* [List of Motors](/docs/motors/#motors)
4848

4949

5050
## Software
5151

5252
### Operating System
5353

54-
* [Kernel v3.16](ev3dev-linux-kernel)
55-
* [Debian 8 Jessie](ev3dev-debian-distro)
56-
57-
### Applications
58-
59-
* [fbcat (screen capture)](fbcat)
54+
* [Kernel v3.16](../ev3dev-linux-kernel)

docs/sensors/using-i2c-sensors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,8 +247,8 @@ With the mindsensors.com Realtime Clock Sensor on input port 2.
247247
00: 46 72 65 65 20 72 61 6d Free ram
248248
10: 20 73 70 61 63 65 21 space!
249249

250-
[lego-sensor]: ../lego-sensor-class
250+
[lego-sensor]: /docs/drivers/lego-sensor-class
251251
[I2C Sensor Addressing]: ../i2c-sensor-addressing
252252
[port splitter]: http://mindsensors.com/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=79
253253
[sensor MUX]: http://mindsensors.com/index.php?module=pagemaster&PAGE_user_op=view_page&PAGE_id=179
254-
[nxt-i2c-sensor]: ../nxt-i2c-sensor
254+
[nxt-i2c-sensor]: /docs/drivers/nxt-i2c-sensor

docs/tutorials/adding-new-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To do this, open a browser and navigate to the [website repository]. Make
3131
sure that you are signed in to your GitHub account, and then click the "fork"
3232
button in the upper-right corner.
3333

34-
<img src="https://github-images.s3.amazonaws.com/help/repository/fork_button.jpg" style="max-width: 300px;" />
34+
<img src="https://github-images.s3.amazonaws.com/help/repository/fork_button.jpg" style="max-width: 300px;" alt="github screenshot" />
3535

3636
It should take a second, but when GitHub finishes processing your request you
3737
should be at a page very similar to where you started, except now you are
@@ -104,7 +104,7 @@ select "gh-pages."
104104

105105
Now click the green "Compare, review and pull request" button.
106106

107-
<img src="https://github-images.s3.amazonaws.com/help/pull_requests/pull-request-start-review-button.png" style="max-width: 300px;" />
107+
<img src="https://github-images.s3.amazonaws.com/help/pull_requests/pull-request-start-review-button.png" style="max-width: 300px;" alt="github screenshot" />
108108

109109
Then click "Create pull request," and enter a title and brief description of
110110
your new page before clicking the button that says "Create pull request" again

0 commit comments

Comments
 (0)