[LIBDCE] Add function descriptor in libdce header file
authorSaurabh Bipin Chandra <a0131926@ti.com>
Wed, 4 Sep 2013 16:23:25 +0000 (21:53 +0530)
committerSaurabh Bipin Chandra <a0131926@ti.com>
Thu, 5 Sep 2013 16:09:16 +0000 (21:39 +0530)
This patch adds function descriptors in the libdce.h.
The xdc/std.h inclusion is shifted from libdce.c to
libdce.h to remove the need of client application
including xdc/std.h.

Change-Id: I4b9e6f12643b130a2cf1d317c4fed595008c7812
Signed-off-by: Saurabh Bipin Chandra <a0131926@ti.com>
libdce.c
libdce.h

index f791e18cc13a9d8630de6a7818ae6e24c4124302..25d0789c48222d9e5ea287c840e75c5764ce07ce 100644 (file)
--- a/libdce.c
+++ b/libdce.c
@@ -71,8 +71,6 @@
 #include <sys/stat.h>     /* For mode constants */
 #include <semaphore.h>
 
-#include <xdc/std.h>
-
 /* IPC Headers */
 #include <MmRpc.h>
 
@@ -85,9 +83,9 @@
 
 /********************* GLOBALS ***********************/
 /* Hande used for Remote Communication                               */
-static MmRpc_Handle       MmRpcHandle = NULL;
-sem_t                    *dce_semaphore = NULL;
-static int                count = 0;
+static MmRpc_Handle    MmRpcHandle = NULL;
+sem_t                 *dce_semaphore = NULL;
+static int             count = 0;
 
 
 /****************** INLINE FUNCTIONS ********************/
index b008e2891600a85765013d15849ab17e45a51971..cffa006d64f241041ae25e0bbe0413c47b57cdc8 100644 (file)
--- a/libdce.h
+++ b/libdce.h
@@ -33,7 +33,7 @@
 #ifndef __LIBDCE_H__
 #define __LIBDCE_H__
 
-
+#include <xdc/std.h>
 #include <ti/sdo/ce/Engine.h>
 #include <ti/sdo/ce/video3/viddec3.h>
 #include <ti/sdo/ce/video2/videnc2.h>
@@ -44,8 +44,7 @@
 #define xdc__ARGTOFXN
 #endif /* BUILDOS_LINUX */
 
-
-/* DCE Error Types */
+/********************************** DCE Error Types **********************************/
 typedef enum dce_error_status {
     DCE_EOK = 0,
     DCE_EXDM_FAIL = -1,
@@ -58,13 +57,22 @@ typedef enum dce_error_status {
     DCE_ESEMAPHORE_FAIL = -8
 } dce_error_status;
 
-
-/* other than the codec-engine API, you must use the following two functions
- * to allocate the data structures passed to codec-engine APIs (other than the
- * raw input/output buffers which should be passed as virtual addresses in
- * TILER space
+/***************************** Memory Allocation/Free APIs *****************************/
+/*=====================================================================================*/
+/** dce_alloc               : Allocate the Data structures passed to codec-engine APIs
+ *                             except Input/Output buffers.
+ *
+ * @ param sz    [in]       : Size of memory to be allocated.
+ * @ return                 : Pointer to allocated memory.
  */
 void *dce_alloc(int sz);
+
+/*=====================================================================================*/
+/** dce_free                : Free the Data structures passed to codec-engine APIs
+ *                             except Input/Output buffers.
+ *
+ * @ param ptr   [in]       : Pointer to allocated memory.
+ */
 void dce_free(void *ptr);
 
 
@@ -106,8 +114,18 @@ int dce_buf_lock(int num, size_t *handle);
 int dce_buf_unlock(int num, size_t *handle);
 
 /******************************* OMAPDRM Get/Set FD APIs *******************************/
+/*=====================================================================================*/
+/** dce_get_fd              : Get OMAP DRM File Descriptor.
+ *
+ * @ return                 : OMAP DRM File Descriptor.
+ */
 int dce_get_fd();
 
+/*=====================================================================================*/
+/** dce_set_fd              : Set OMAP DRM File Descriptor.
+ *
+ * @ param fd     [in]      : OMAP DRM File Descriptor.
+ */
 void dce_set_fd(int fd);