[PATCH rtems-central] spec/cache/coherent: Add return value for add area

Kinsey Moore kinsey.moore at oarcorp.com
Wed Jan 24 17:19:44 UTC 2024


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.
---
 spec/rtems/cache/if/coherent-add-area.yml | 14 ++++++++++++--
 1 file changed, 12 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..325d043c 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: rtems_status_code
   variants: []
 description: null
 enabled-by: true
@@ -40,5 +40,15 @@ params:
     is the size in bytes of the cache coherent memory area to add.
   dir: null
   name: size
-return: null
+return:
+  return: |
+    Returns a rtems_status_code indicating whether the area was added to cache
+    coherent memory.
+  return-values:
+  - description: |
+      The cache coherent memory extension was successful.
+    value: ${../../status/if/successful:/name}
+  - description: |
+      The cache coherent memory extension was not successful.
+    value: ${../../status/if/unsatisfied:/name}
 type: interface
-- 
2.39.2



More information about the devel mailing list