Commit graph

138 commits

Author SHA1 Message Date
Jeff Epler
4c3c1609c1 manpages: document alias APIs
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-10-10 11:45:25 -05:00
Jeff Epler
f529fae1a7 rtapi: implement subset of <stdatomic.h>
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-08-03 19:06:43 -05:00
Sebastian Kuzminsky
5f9480d62c docs: ficks a typoe in rtapi_print(3) manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-07-14 14:56:58 -06:00
Jeff Epler
1ff8d47e9d rtapi: document that rtapi_task_self may be called from init/cleanup
.. and that it will return -EINVAL in this state

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2015-04-18 21:22:06 -05:00
Sebastian Kuzminsky
7021767c5f Merge remote-tracking branch 'origin/2.6' into 2.7 2015-04-03 17:09:56 -06:00
Sebastian Kuzminsky
de51d6bdb4 docs: fix hal_pin_new() and hal_param_new() manpages
The data types for the pin & parameter directions were wrong.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2015-04-01 08:33:25 -06:00
Norbert Schechner
e20164aba7 Merge branch '2.6' into 2.7 2014-12-27 18:47:12 +01:00
Sebastian Kuzminsky
4636af2152 docs: fixup manpage syntax for rtapi_app_main.3 & rtapi_app_exit.3
Before this, the rtapi_app_main.3 manpage had the #include and the
function declaration on the same line, this breaks them apart to separate
lines.

Also adds the #include <rtapi.h> to th rtapi_app_exit.3 manpage.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-27 08:56:06 -07:00
Sebastian Kuzminsky
00029a193b Merge remote-tracking branch 'origin/2.6' into 2.7 2014-12-25 11:44:19 -07:00
Sebastian Kuzminsky
7d2abeedb8 docs: fix inaccuracies in hal_init manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-25 11:43:38 -07:00
Sebastian Kuzminsky
37f73ab5f0 Merge origin/2.6 into 2.7 (using imerge) 2014-12-08 23:25:51 -07:00
Sebastian Kuzminsky
02b2bb3c94 docs: move the skeleton manpages out of the way
This means there's no need to filter out the skeletons from the manpage
list in the docs/src/Submakefile any more.

Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-05 23:33:03 -07:00
Sebastian Kuzminsky
e7e96c2742 docs: fix a misnamed rtapi manpage
Signed-off-by: Sebastian Kuzminsky <seb@highlab.com>
2014-12-03 17:15:16 -07:00
Jeff Epler
bf9ee2de97 documentation: add manpage for rtapi_byteorder
Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2014-10-02 19:19:36 -05:00
Jeff Epler
57e1d5465e docs: Note GPL license on files 2014-07-28 09:29:03 -05:00
Jeff Epler
756883ae61 rtapi: document rtapi_parport 2014-07-21 07:21:11 -05:00
Jeff Epler
d32671c21e rtapi: document new header 2014-07-21 07:21:11 -05:00
Jeff Epler
220f589ff6 rtapi: document new headers 2014-07-21 07:21:10 -05:00
Jeff Epler
3eac731ce7 rtapi: Can we run with realtime guarantee? 2014-07-20 20:49:09 -05:00
Jeff Epler
9a606843cb docs: Documentation changes for uspace 2014-07-20 20:49:09 -05:00
Jeff Epler
e2743b95fd rtapi: provide rtapi_bool.h
Including this header ensures that bool / true / false are available no matter
the circumstances (userspace / kernelspace, C / C++).
2014-07-20 20:49:08 -05:00
Jeff Epler
5c18f5a3b7 docs: Fix cut&paste errors
.. somebody forgot to fully customize their skeleton.
2014-07-12 10:24:06 -05:00
Sebastian Kuzminsky
3def129263 docs: rebrand manpages 2013-11-17 16:15:35 -07:00
Andy Pugh
3b736bb6ae Add (or make less ambiguous) the licensing of a number of files.
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2013-09-25 20:35:45 +01:00
Jeff Epler
a7ccc9add0 Add license notices
.. to these new-in-master files where git says I am the sole author
2013-09-18 21:43:00 -05:00
Jeff Epler
198b45e68f Merge branch 'v2.5_branch' 2013-09-17 11:28:35 -05:00
Jeff Epler
32460b2f95 document the interpretation of MODULE_LICENSE strings 2013-09-17 11:27:57 -05:00
Jeff Epler
6018a79e51 rtapi_math64: signed versions. (Seem to work, ap) 2013-09-08 21:42:54 +01:00
Andy Pugh
0cd2f98d52 Add support for the Hostmot2 UARTs
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2012-05-31 01:57:50 +01:00
Jeff Epler
f29fc9da60 rtapi_limits.h: define INT_MIN and friends portably
A quick check in LXR shows that in 2.6.28 and in 3.3 (and presumably the
intervening version), <linux/kernel.h> defines a dozen integer limit
macros including INT_MIN.
2012-04-05 10:55:01 -05:00
Michael Haberler
cf41ac29cf Merge branch 'v2.5_branch' 2012-01-27 20:16:12 +01:00
John Thornton
d4ff1bf165 Docs: re-branding
Signed-off-by: John Thornton <jthornton@gnipsel.com>
2012-01-27 07:02:25 -06:00
Sebastian Kuzminsky
b9baa4d105 Merge remote branch 'origin/v2.5_branch'
Conflicts:
	docs/src/gcode/overview.txt
	scripts/linuxcnc.in
2012-01-21 12:40:55 -07:00
Jeff Epler
f34124af79 manpages: say "LinuxCNC" 2012-01-19 18:31:23 -06:00
Jeff Epler
606d8328f6 hal: Introduce hal_bool, use it for hal_bit_t
The C99 _Bool type and the C++ bool type have an advantage over other
integral types: they only have two distinct values.  Expressions like
'b1 == b2', 'b1 << 3' and 'b1 ^ b2' behave like you would expect a
boolean type to behave, rather than having the problems that result from
using an integral type with more than two distinct values.
2011-11-17 15:05:56 -06:00
Andy
d696bccee3 Some part of my workstream has been randomly setting execute bits.
This commit resets all the ones I have spotted.


Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2011-08-16 00:41:53 +01:00
Andy Pugh
ae88038288 Documentation for the Hostmot2 BSPI Driver
Signed-off-by: Andy Pugh <andy@bodgesoc.org>
2011-08-15 23:32:53 +01:00
Jeff Epler
1446aa6f28 rtapi_vsnprintf: document the limitations 2011-08-14 18:43:14 +00:00
Jeff Epler
a4971ede05 rtapi_math64.h: division and remainder of 64-bit quantities
this is frequently desirable, but merely writing the obvious
x % y formulation can lead to the 'undefined symbol __umoddi3'
error.

Linux provides some routines to do division of 64-bit quantities
by 32-bit divisors; adopt this in rtapi, and provide a version written
in the obvious way when in userspace.
2011-08-14 18:41:18 +00:00
Jeff Epler
4ab5a6b376 rtapi_byteorder: what's architecture's byte order?
as usual, a different gyration is required for kernel than for userspace.
Harmonize it.
2011-08-14 18:41:17 +00:00
Jeff Epler
78919de4a1 Remove outdated warning about rtapi_get_time
The current implementation in rtai returns accurate times without
much overhead (hundreds of ns at worst, according to measurements by
Andy Pugh).  Remove this superstitious advice.
2011-07-18 13:36:52 -05:00
Jeff Epler
1343de75fa hal: document hal_parport.h APIs 2011-02-07 08:57:20 -06:00
Jeff Epler
dc31d02f03 try to document the s32 gotcha 2011-02-04 09:08:21 -06:00
Jeff Epler
8bfab6831e documentation: HAL APIs don't truncate long names 2010-06-07 07:48:05 -05:00
Jeff Epler
e7bd83137d explain when rtapi_app_exit is not called 2009-09-20 12:39:36 -05:00
Jeff Epler
296ff42f20 fix typo 2009-09-20 12:39:36 -05:00
Jeff Epler
e1a968ae8f fix prototypes for several functions 2009-08-24 13:58:27 -05:00
Jeff Epler
e2231f8c5c got rid of error defines
we may want to defer this until later, if we are concerned about users
of hal or rtapi outside the emc2 source tree

Signed-off-by: Jeff Epler <jepler@unpythonic.net>
2009-06-20 11:33:10 -05:00
Jeff Epler
47b82cb0e2 additional notes and realtime considerations 2008-12-06 14:27:22 +00:00
Jeff Epler
5058319bc2 clarify availability of rtapi_inb/rtapi_outb in userspace components 2008-12-06 14:20:53 +00:00
Jeff Epler
ccd4270903 add links for all the macros described in rtapi_module_param 2008-12-06 14:20:53 +00:00
Jeff Epler
4fd5d06ff4 overview of realtime considerations 2008-11-26 03:40:23 +00:00
Jeff Epler
3c8a35c0af seems these functions are not in ulapi 2008-11-26 03:40:10 +00:00
Jeff Epler
3917e0a0d9 explain newly-introduced types 2008-11-12 13:26:06 +00:00
Jeff Epler
2c030a70c0 one-line description of funct 2008-05-26 14:23:30 +00:00
Jeff Epler
9b08f4053d new manual pages 2008-05-26 13:50:34 +00:00
Jeff Epler
04885dfb84 whoops, didn't show prototype for rtapi_inb 2008-05-09 12:41:29 +00:00
Jeff Epler
755c4891e2 start documenting the posemath library 2008-02-16 23:36:47 +00:00
Jeff Epler
abc3a3d020 reflect addition of const qualifiers to APIs that take char* 2008-01-29 13:57:53 +00:00
Jeff Epler
f189284fff document rtapi_math.h and rtapi_string.h so I can point accusingly at people who don't remember to use those istead of the system includes 2007-11-14 16:41:16 +00:00
Jeff Epler
c71c21908a typo 2007-09-20 14:48:11 +00:00
John Kasunich
606d90cb44 document requirement that threads be created fastest first 2007-05-13 07:05:45 +00:00
John Kasunich
ff94f6ad06 document hal_unlink and hal_link changes 2007-05-11 03:40:43 +00:00
Jeff Epler
74ffe2c1c6 make it an error for hal_link(), halcmd linkXX, halcmd net to link a pin to a
signal when the pin was already linked to a different signal.  This is a common
error made by users who are configuring shared home/limit switches, because
they try to attach one input pin to several signals.
2007-05-11 02:40:17 +00:00
Alex Joni
51fca7a11f fix wrong TH header (referring to a different section) 2007-04-01 13:36:13 +00:00
Jeff Epler
134626514d document hal types better 2007-01-16 20:15:12 +00:00
Jeff Epler
8c5efae1ef add note about how to compute time deltas with integer math 2007-01-16 20:15:06 +00:00
Jeff Epler
4199e462af markup fix 2007-01-13 19:31:58 +00:00
Jeff Epler
85d7ed9603 add rtapi_set_msg_handler and rtapi_get_msg_handler so that apps using
rtapi can redirect the messages in whatever way they desire
2007-01-06 04:07:47 +00:00
Jeff Epler
06dc00478d there is no 'num' parameter to the non-array parameter macros 2006-11-25 16:39:41 +00:00
Jeff Epler
7875ed6601 having a blank first line makes 'groff -Tps' put a blank page at the start of the output 2006-11-20 03:44:30 +00:00
Jeff Epler
4441c1bded 8- and 16-bit hal types no longer exist 2006-11-19 13:57:07 +00:00
Alex Joni
6199e4002c s16 and u16 don't exist anymore in HAL 2006-11-19 13:12:43 +00:00
Alex Joni
d6e82a674f s8 doesn't exist anymore in HAL 2006-11-19 13:09:12 +00:00
Alex Joni
f08269dc3e u8 types don't exist anymore in HAL 2006-11-19 13:07:30 +00:00
Jeff Epler
5cc4ae401e these were documented in rtapi_region.3rtapi but didn't have links to these names 2006-11-03 01:55:40 +00:00
Jeff Epler
55dbb50a14 refer to hal_type_t manpage 2006-10-16 20:35:34 +00:00
Jeff Epler
0e24628a80 markup fixes 2006-10-14 14:36:51 +00:00
John Kasunich
551cf908b8 fix a few minor errors 2006-10-14 04:19:08 +00:00
Jeff Epler
ba3143ff90 new manpages 2006-10-14 02:24:41 +00:00
Jeff Epler
c5857f475d hal_link is on this page 2006-10-13 15:22:29 +00:00
Jeff Epler
6d9789cd52 note that set_period can return a failure code 2006-10-13 15:15:54 +00:00
Jeff Epler
4f66e398c9 don't source yourself 2006-10-13 15:15:37 +00:00
Jeff Epler
d06904a904 new manpages 2006-10-13 14:07:55 +00:00
Jeff Epler
ecf7d24f64 fix up .so includes and add more of them 2006-10-13 02:50:05 +00:00
Jeff Epler
b28baaa9ca make all the hal_p...new functions have entries 2006-10-13 02:42:43 +00:00
Jeff Epler
6f8eeb8b00 markup fix 2006-10-13 02:42:15 +00:00
Jeff Epler
ac454022fc manpages for many rtapi and hal functions, mostly taken from the comments
in hal.h and rtapi.h
2006-10-12 22:32:20 +00:00