Skip to content

Commit

Permalink
got rid of error defines
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
jepler committed Jun 20, 2009
1 parent 81f1d6c commit e2231f8
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 63 deletions.
33 changes: 2 additions & 31 deletions docs/man/man3/intro.3hal
Original file line number Diff line number Diff line change
Expand Up @@ -67,37 +67,8 @@ data.
For an explanation of realtime considerations, see \fBintro(3rtapi)\fR.

.SH HAL STATUS CODES

.TP
HAL_SUCCESS
call successful
.TP
HAL_UNSUP
function not supported
.TP
HAL_BADVAR
duplicate or not-found variable name
.TP
HAL_INVAL
invalid argument
.TP
HAL_NOMEM
not enough memory
.TP
HAL_LIMIT
resource limit reached
.TP
HAL_PERM
permission denied
.TP
HAL_BUSY
resource is busy or locked
.TP
HAL_NOTFND
object not found
.TP
HAL_FAIL
operation failed
Except as noted in specific manual pages, HAL returns negative errno values
for errors, and nonnegative values for success.

.SH SEE ALSO
\fBintro(3rtapi)\fR
33 changes: 3 additions & 30 deletions docs/man/man3/intro.3rtapi
Original file line number Diff line number Diff line change
Expand Up @@ -50,33 +50,6 @@ and also devices which use Linux kernel APIs to do things like create
special devices or entries in the \fB/proc\fR filesystem.

.SH RTAPI STATUS CODES
.TP
RTAPI_SUCCESS
call successfull
.TP
RTAPI_UNSUP
function not supported
.TP
RTAPI_BADID
bad task, shmem, sem, or fifo ID
.TP
RTAPI_INVAL
invalid argument
.TP
RTAPI_NOMEM
not enough memory
.TP
RTAPI_LIMIT
resource limit reached
.TP
RTAPI_PERM
permission denied
.TP
RTAPI_BUSY
resource is busy or locked
.TP
RTAPI_NOTFND
object not found
.TP
RTAPI_FAIL
operation failed
Except as noted in specific manual pages, RTAPI returns negative errno values
for errors, and nonnegative values for success.

4 changes: 2 additions & 2 deletions docs/man/man3/rtapi_clock_set_period.3rtapi
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ hardware and RTOS limitations, the actual period may not be exactly what was
requested. On success, the function will return the actual clock period if it
is available, otherwise it returns the requested period. If the requested
period is outside the limits imposed by the hardware or RTOS, it returns
\fBRTAPI_INVAL\fR and does not start the clock. Once the clock is started,
subsequent calls with non-zero \fInsec\fR return \fBRTAPI_INVAL\fR and have no
\fB-EINVAL\fR and does not start the clock. Once the clock is started,
subsequent calls with non-zero \fInsec\fR return \fB-EINVAL\fR and have no
effect. Calling \fBrtapi_clock_set_period\fR with \fInsec\fR set to zero
queries the clock, returning the current clock period, or zero if the clock has
not yet been started.
Expand Down

0 comments on commit e2231f8

Please sign in to comment.