summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKinsey Moore <kinsey.moore@oarcorp.com>2024-01-24 11:00:38 -0600
committerJoel Sherrill <joel@rtems.org>2024-01-26 08:20:38 -0600
commit8966d7063513ce5a733218dc36bf89f3988c025f (patch)
treef5c8b16742f4c80183e9a6ce5a0f53297f8c1a92
parentmodules: Update rtems-docs (diff)
downloadrtems-central-8966d7063513ce5a733218dc36bf89f3988c025f.tar.bz2
spec/cache/coherent: Add return value for add area
This changes the return type for rtems_cache_coherent_add_area from void to rtems_status_code so that the function can report errors when they occur.
-rw-r--r--spec/rtems/cache/if/coherent-add-area.yml12
1 files changed, 10 insertions, 2 deletions
diff --git a/spec/rtems/cache/if/coherent-add-area.yml b/spec/rtems/cache/if/coherent-add-area.yml
index 410f3c58..1b2f19f8 100644
--- a/spec/rtems/cache/if/coherent-add-area.yml
+++ b/spec/rtems/cache/if/coherent-add-area.yml
@@ -10,7 +10,7 @@ definition:
params:
- void *${.:/params[0]/name}
- ${/c/if/uintptr_t:/name} ${.:/params[1]/name}
- return: void
+ return: ${../../status/if/code:/name}
variants: []
description: null
enabled-by: true
@@ -40,5 +40,13 @@ params:
is the size in bytes of the cache coherent memory area to add.
dir: null
name: size
-return: null
+return:
+ return: null
+ return-values:
+ - description: |
+ The requested operation was successful.
+ value: ${../../status/if/successful:/name}
+ - description: |
+ The requested operation was not successful.
+ value: ${../../status/if/unsatisfied:/name}
type: interface