From bd22b2300c0741bfa3e294443dc86a847adbb24f Mon Sep 17 00:00:00 2001 From: Robert Lind Date: Tue, 7 Sep 2010 12:33:40 +0200 Subject: b2r2lib: Added documentation files in ste-info ST-Ericsson ID: 264979 Change-Id: I63554ae34048cca36df25941cb8be3baac2f519b Reviewed-on: http://gerrit.lud.stericsson.com/gerrit/4658 Tested-by: Robert LIND Reviewed-by: Robert FEKETE --- ste-info/toc-locations.xml | 8 + ste-info/userspace_std_api_b2r2lib.xml | 354 +++++++++++++++++++++++++++++++++ 2 files changed, 362 insertions(+) create mode 100755 ste-info/toc-locations.xml create mode 100755 ste-info/userspace_std_api_b2r2lib.xml diff --git a/ste-info/toc-locations.xml b/ste-info/toc-locations.xml new file mode 100755 index 0000000..aa7d4d6 --- /dev/null +++ b/ste-info/toc-locations.xml @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/ste-info/userspace_std_api_b2r2lib.xml b/ste-info/userspace_std_api_b2r2lib.xml new file mode 100755 index 0000000..1aa31cd --- /dev/null +++ b/ste-info/userspace_std_api_b2r2lib.xml @@ -0,0 +1,354 @@ + + + + + bltlib + + + + 2010 + ST-Ericsson AB + + + + + + + + Introduction + + + bltlib is a library and API towards the device driver for the B2R2 graphics hardware. + + + + + + Conformance Description + +
+ Introduction + + This chapter describes conformance and implementation-defined + behaviour of the module. +
+ +
+ References + + + + + + + + Title + Web Link + + + + + + + OpenMAX AL 1.0.1 + + Khronos registry (OpenMAX AL) + + --> + + + + + +
+
+ Function Conformance + + + TODO: For each function or set of functions, + supply one row indicating functions, + the header file defining the function + and the level of implementation support + provided by the platform. + + A conformance description describes which features, + interfaces of the standard that are supported or not + supported. + + While the UML model may reference features, + or featuresets or functionality, in the broad sence, + this table must explicitly list all functions or other + means of controlling the API, so that a developer + knows for each and every function if the function is + implemented or not. + + All header files that defines functions + must be listed and linked using (ulink), and also + referenced in the toc-locations.xml file. + + What is stated about functions, is also valid if the module + implements an API in another way, such as using methods, + operations or signals. + + + + + + + Functions + Header File + Description/Conformance + + + + + All functions + blt_api.h + Functions/Functionality are fully implemented + + + + + + See Implementation Description for implementation-defined behaviour. + +
+ + + + Implementation Description + + +
+ Implementation details + + + + The client fills in a blt_req struct with all of the information required for the + blitting job. + + The request method then submits the job to the blitting driver and hardware. + The driver analyzes the job and splits it into the required nodes. + If the job is run in synchronous mode, the request method returns only when the + job has been completed (or has failed). If the job is run in asynchronous mode, + the request method returns immediately. The client can use the synch method to + wait for completion. + + When a client sends a request to bltlib, the job is sorted into a prioritized queue. + When the job can acquire the resources it needs, it is dispatched to the blitting hardware. + + + + + +
+ +
+ Supported versions + + + This section specifies the supported versions of the module. + + + bltlib supports only a subset of the bitmap formats defined by OpenMAX, + due to limitations in the blitting hardware. + + + + +
+ + + + Specifications + + + bltlib does not implement a standard specification but defines its own API. + Still, it borrows from some of the data types used in OpenMAX. + + + + OpenMAX AL 1.0.1 + + + --> + + + + + Khronos registry (OpenMAX AL) + + + + + + + + -- cgit v1.2.3