Commit graph

397 commits

Author SHA1 Message Date
John Thornton
9dd801e290 Docs: fix typo, remove extra ] that made the formatting fail
Signed-off-by: John Thornton <bjt128@gmail.com>
2018-06-25 16:16:27 -05:00
Sebastian Kuzminsky
3f05545ef1 docs: pwmgen has all pins now, no params
Also update comments in pwmgen.c to reflect that HAL connections are
all via pins instead of params.  No code changes.
2018-06-19 11:38:14 -06:00
Sebastian Kuzminsky
c2b378391e docs: improve motion.requested-vel description 2018-06-12 20:06:25 -06:00
Sebastian Kuzminsky
310bbbf52e docs: describe motion.program-line in motion manpage 2018-04-03 11:09:36 -06:00
Sebastian Kuzminsky
ade72db610 docs: add missing num_sserials info to hm2 manpage 2018-02-22 08:41:18 -07:00
Sebastian Kuzminsky
22fafd6198 fix paramter/parameter typos all over 2018-01-21 14:49:13 -07:00
Sebastian Kuzminsky
fec7bf9a69 fix preceede/precede/proceed typos all over 2018-01-21 14:49:12 -07:00
Sebastian Kuzminsky
4a897203bc docs: fix hyphen/minus confusion in manpages
groff treats '-' (the character you get when you hit the "minus" key on
the keyboard) as "hyphen", not as "minus".  Thus it renders incorrectly
in some locales, and line-wraps strangely.

groff treats the two-character sequence "\-" as "minus", and the
four-character sequence "\(hy" as "hyphen".

Details here: https://lists.debian.org/debian-devel/2003/03/msg01481.html

This commit replaces every instance of "-" in our manpages where the
meaning is "minus" with "\-", so it works right.

This fixes many lintian warnings.
2018-01-18 08:12:31 -07:00
Sebastian Kuzminsky
714d85657b mux_generic: fix a typo in the manpage 2017-12-11 11:32:02 -07:00
Sebastian Kuzminsky
de97fdd108 docs: improve .motion-type pin info in motion manpage 2017-12-05 22:19:58 -07:00
andy pugh
66a518e1f8 hostmot2:dpll: Fix a problem (#211) where a positive offset in the odd timers
masked any use of the even timers.


Signed-off-by: andy pugh <andy@bodgesoc.org>
2017-10-18 22:32:42 +01:00
Sebastian Kuzminsky
724f2c395d docs: remove mention of ancient "bfloat" program from hm2_7i43 manpage 2017-08-23 09:40:05 -06:00
Sebastian Kuzminsky
67490eca8f hm2_eth: add support for Mesa 7i93 AnyIO ethernet board
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-06-18 10:59:03 -06:00
Sebastian Kuzminsky
4cacd7c4c2 docs: sort board list in hm2_eth manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2017-04-27 21:38:08 -06:00
John Thornton
1489c87181 Docs: fix issue #143
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-08-16 11:09:36 -05:00
Jeff Epler
f581faef25 hm2_eth: doc updates
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
52febb5f38 hm2_eth: improve docs
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:03 -05:00
Jeff Epler
ce80671f13 hm2_eth: detect lost reads and writes
.. with a pile of new tunables (yuck)

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-06-10 20:48:02 -05:00
Jeff Epler
01e82b2989 motion: remove overruns parameter
After the removal of heuristic overrun detection, this param's value
was never changed from 0.

As noted clearly in the documentation, this parameter was for debugging
and subject to removal at any time, so we don't need to wait to remove
it.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-05-10 12:52:43 -05:00
Sam Sokolik
6ceba7a9bb irq-coalesce requires ethtools
Signed-off-by: Sam Sokolik <samcoinc@gmail.com>
2016-05-10 10:53:05 -06:00
Jeff Epler
8c082eaac5 hm2_eth: note the irq-coalesce trick
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2016-04-12 13:04:18 -05:00
John Thornton
59e5b75d78 Docs: add supported boards
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-02-04 07:07:22 -06:00
John Thornton
0baf37dce6 Docs: fix markup, for some strange reason the \fB did not carry over to the next line
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-01-28 06:37:24 -06:00
Jeff Epler
4d02519fb4 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	VERSION
	debian/changelog
2016-01-16 09:47:24 -06:00
John Thornton
d819fef886 Docs: change aio from 16 to 64
Signed-off-by: John Thornton <bjt128@gmail.com>
2016-01-14 09:08:55 -06:00
Sebastian Kuzminsky
21ae4806b3 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	docs/man/man9/hm2_7i90.9
2015-10-29 10:28:57 -06:00
Sebastian Kuzminsky
2485089f9c hm2_7i90 manpage: clarify firmware management
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-10-29 09:58:04 -06:00
Sebastian Kuzminsky
a6bda7b46a hm2_7i90 manpage: remove incorrect EPP info
The factoring out of the 7i43/7i90/etc EPP driver code never progressed
beyond a good intention.

Thanks to Andy Pugh for the bug report.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-10-29 09:57:47 -06:00
Jeff Epler
3b24d38347 manpages: markup fixes
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-10-10 11:45:29 -05:00
Jeff Epler
5f8123045a hostmot2: don't let ntp cause following errors
.. by tuning the dpll so that it can handle the +-500ppm
changes in the linux CLOCK_MONOTONIC rate that can be caused
by software like ntpd and ntpdate.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-09-03 09:54:07 -05:00
Sebastian Kuzminsky
6a5ad145d7 Merge remote-tracking branch 'origin/2.6' into 2.7
Conflicts:
	docs/man/man9/hostmot2.9
2015-07-29 10:19:37 -06:00
andypugh
fcc3b0c339 Smart-serial boards can have HAL pins identified by board serial numbers. Document this.
Signed-off-by: andypugh <andy@bodgesoc.org>
2015-07-23 19:16:48 +02:00
Jeff Epler
06ca091fad hostmot2: support split reads
.. by a new read-request function.  This is useful on systems
with more than one hm2_eth card, because the transmission of the
second read request can overlap with the first card processing
and responding to its read request.

This also splits the multiple personalities of "queue_read",
so that the length argument to "queue_read" is no longer
overloaded to select whether to queue / actually send / actually
receive the requested reads.

It also fixes the new functions so that they return success /
failure codes correctly; before, some send/recv failures were
logged via LL_PRINT but not by return value.

It also moves rtapi_delay so that the delay is only taken after a
failed recv().  With multiple cards, this typically removes
the delay for all ethernet cards after the first.

In my hal-test harness, these measures together lowered the typical
thread1.time by >40% with two cards.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-07-18 11:37:57 -05:00
Jeff Epler
a00817f8b8 hm2_eth: allow multiple instances (up to 4)
.. including on a single gigabit ethernet interface with a
gigabit switch between the PC and multiple hostmot2 cards.

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-07-18 11:37:57 -05:00
Sebastian Kuzminsky
7679b83624 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-07-15 18:57:43 -06:00
Sebastian Kuzminsky
4ef16263f0 docs: document motion.feed-inhibit better
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-07-15 17:36:35 -06:00
Jeff Epler
6df518d96b hm2_eth: do iptables and sysctl configuration automatically
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-06-30 17:24:00 -05:00
Sebastian Kuzminsky
8163316158 Merge remote-tracking branch 'origin/2.6' into 2.7 2015-06-29 23:14:00 -06:00
Sebastian Kuzminsky
20b05daf60 docs: update encoder.9 manpage
The encoder comp has no parameters, and the min-velocity-estimate pin
is really called min-speed-estimate (because it's direction-insensitive).

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-06-29 23:10:09 -06:00
Jeff Epler
adbff9cde1 hm2: encoder: enable dpll when supported by firmware
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-06-25 16:43:54 -05:00
Jeff Epler
b8948eec06 hm2: improve documentation of timers
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-06-25 16:43:53 -05:00
John Thornton
70a054bdd9 Docs: restore guess as to what was causing the build warnings
Signed-off-by: John Thornton <bjt128@gmail.com>
2015-06-17 06:26:58 -05:00
John Thornton
c83f2d33a7 Docs: fix build warnings
Signed-off-by: John Thornton <bjt128@gmail.com>
2015-06-16 12:55:12 -05:00
John Thornton
7fb10751b0 Docs: fix build warnings
Signed-off-by: John Thornton <bjt128@gmail.com>
2015-06-16 06:12:16 -05:00
John Thornton
736b0e4231 Docs: fix build errors and minor markup fixes
Signed-off-by: John Thornton <bjt128@gmail.com>
2015-06-15 06:11:42 -05:00
Dewey Garrett
9ea94bb71b streamer.c: add clock,clock-mode pins
note: default clock-mode (0) behavior is identical to
      prior behavior

Credit to: Slavko Kocjancic
Author's info:
 15. November 2014 addition by eslavko
 streamer.N.cur-depth, streamer.N.empty and streamer.N.underruns are
 now (correctly) updated even if streamer.N.enabled is set to false.
 in addition there are two new pins to enable clocking streamer.
 by default values the streamer behaviour is as before update.
 the new pin is
 streamer.N.clock bit input
 it's clock input with actions defined by clock_mode pin.
 streamer.N.clock-mode s32 input
 define behaviour of clock pin.
 value 0 (default) freerun at every loop
 value 1 means clock by falling edge
 value 2 means clock by rising edge
 value 3 meand clock by any edge

Signed-off-by: Dewey Garrett <dgarrett@panix.com>
2015-04-24 08:29:45 -07:00
Jeff Epler
e868776261 hm2_eth: it's our elbpcom program now
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-19 12:12:15 -05:00
Jeff Epler
da07d64aaf hm2_eth: note some LED gotchas
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 21:22:07 -05:00
Jeff Epler
067b8f7bef hostmot2: comment about functions that don't work well on hm2_eth
.. due to extra packet generation

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 21:22:06 -05:00
Chris Radek
18a933a176 Remove probe_parport, which is unneeded since we now cooperate with parport_pc
Signed-off-by: Chris Radek <chris@timeguy.com>
2015-01-14 20:24:34 -06:00