Skip to content

Commit f5361ea

Browse files
committed
docs: some additions to #2430
1 parent a2b692d commit f5361ea

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/src/hal/basic-hal.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ This replaces the need to use the command newsig.
132132
The optional direction arrows `<=`, `=>` and `<=>` make it easier to follow the logic when reading a `net` command line and are not used by the net command.
133133
The direction arrows must be separated by a space from the pin names.
134134

135-
.`net` Syntax and Example
135+
.Syntax and Examples of `net`
136136
[source,{hal}]
137137
----
138138
net signal-name pin-name <optional arrow> <optional second pin-name>
@@ -186,7 +186,7 @@ Some components have parameters that need to be set before use.
186186
Parameters can be set before use or while running as needed.
187187
You cannot use setp on a pin that is connected to a signal.
188188

189-
.`setp` Syntax and Example
189+
.Syntax and Examples of `setp`
190190
[source,{hal}]
191191
----
192192
setp <pin/parameter-name> <value>
@@ -198,7 +198,7 @@ setp parport.0.pin-08-out TRUE
198198

199199
The command `sets` sets the value of a signal.
200200

201-
.`sets` Syntax and Example:
201+
.Syntax and Examples of `sets`
202202
[source,{hal}]
203203
----
204204
sets <signal-name> <value>
@@ -219,7 +219,7 @@ The command `unlinkp` unlinks a pin from the connected signal.
219219
If no signal was connected to the pin prior running the command, nothing happens.
220220
The `unlinkp` command is useful for trouble shooting.
221221

222-
.`unlinkp` Syntax and Example
222+
.Syntax and Examples of `unlinkp`
223223
[source,{hal}]
224224
----
225225
unlinkp <pin-name>
@@ -236,7 +236,7 @@ These commands are included so older configurations will still work.
236236

237237
The command `linksp` creates a 'connection' between a signal and one pin.
238238

239-
.`linksp` Syntax and Example
239+
.Syntax and Examples of `linksp`
240240
[source,{hal}]
241241
----
242242
linksp <signal-name> <pin-name>
@@ -250,7 +250,7 @@ linksp X-step parport.0.pin-02-out
250250
The command `linkps` creates a 'connection' between one pin and one signal.
251251
It is the same as `linksp` but the arguments are reversed.
252252

253-
.`linkps` Syntax and Example
253+
.Syntax and Examples of `linkps`
254254
[source,{hal}]
255255
----
256256
linkps <pin-name> <signal-name>
@@ -264,7 +264,7 @@ linkps parport.0.pin-02-out X-Step
264264
the command `newsig` creates a new HAL signal by the name _<signame>_ and the data type of _<type>_.
265265
Type must be 'bit', 's32', 'u32' or 'float'. Error if _<signame>_ already exists.
266266

267-
.`newsig` Syntax and Example
267+
.Syntax and Examples of `newsig`
268268
[source,{hal}]
269269
----
270270
newsig <signame> <type>
@@ -365,7 +365,7 @@ and2.N.in1 (bit, in)
365365
and2.N.out (bit, out)
366366
----
367367

368-
.`and2` Truth Table
368+
.Truth Table of `and2`
369369
[width="90%",options="header"]
370370
|===
371371
|in0 | in1 | out
@@ -397,7 +397,7 @@ not.n.in (bit, in)
397397
not.n.out (bit, out)
398398
----
399399

400-
.`not` Truth Table
400+
.Truth Table of `not`
401401
[width="90%",options="header"]
402402
|===
403403
|in | out
@@ -472,7 +472,7 @@ xor2.n.out (bit, out)
472472
[[sec:hal-logic-examples]]
473473
== Logic Examples(((HAL Logic Examples)))
474474

475-
.`and2` example connecting two inputs to one output
475+
.Example using `and2`
476476
[source,{hal}]
477477
----
478478
loadrt and2 count=1
@@ -499,7 +499,7 @@ The conversion is the sum of the 'weights' of the bits present plus any offset.
499499
It's similar to 'binary coded decimal' but with more options.
500500
The 'hold' bit interrupts the input processing, so that the 'sum' value no longer changes.
501501

502-
.weighted_sum component loading syntax
502+
.Syntax for loading component `weighted_sum`
503503
[source,{hal}]
504504
----
505505
loadrt weighted_sum wsum_sizes=size[,size,...]
@@ -509,7 +509,7 @@ Creates groups of ``weighted_sum``s, each with the given number of input bits (s
509509

510510
To update the `weighted_sum`, the `process_wsums` must be attached to a thread.
511511

512-
.add `process_wsums` function
512+
.Add `process_wsums` to servo thread
513513
[source,{hal}]
514514
----
515515
addf process_wsums servo-thread
@@ -520,7 +520,7 @@ Which updates the `weighted_sum` component.
520520
In the following example, a copy of the AXIS HAL configuration window, bits '0' and '2' are TRUE, they have no offset.
521521
The weight ('weight') of bit 0 is 1, that of bit 2 is 4, so the sum is 5.
522522

523-
.`weighted_sum` Example component Pin for weighted sums.
523+
.Component pins of `weighted_sum`
524524
[width="90%",options="header"]
525525
|===
526526
|Owner |Type |Dir |Value |Name

0 commit comments

Comments
 (0)