Fixed wrong size of shm on server side.

1 files changed, 90 insertions, 5 deletions

diff --git a/include/dlt/dlt_shm.h b/include/dlt/dlt_shm.h
index c12a43a..fc37117 100644
--- a/include/dlt/dlt_shm.h
+++ b/include/dlt/dlt_shm.h
@@ -68,34 +68,119 @@
 #ifndef DLT_SHM_H
 #define DLT_SHM_H
 
+/* shared memory key */
+/* must be the same for server and cleint */
 #define DLT_SHM_KEY  	11771
+
+/* default size of shared memory */
+/* size is extended during creation to fit segment size */
+/* client retreives real size from shm buffer */
 #define DLT_SHM_SIZE	100000
+
+/* Id of the used semaphore */
+/* used for synchronisation of write and read access of multiple clients and server */
+/* must be the same for server and client */
 #define DLT_SHM_SEM		22771
 
 typedef struct
 {
-	int shmid;	// Id of shared memory
-	int semid;	// Id of semaphore
-	char* shm;	// pointer to beginning of shared memory
-	int size; 	// size of data areay in shared memory
-	char* mem;	// pointer to data area in shared memory
+	int shmid;	/* Id of shared memory */
+	int semid;	/* Id of semaphore */
+	char* shm;	/* pointer to beginning of shared memory */
+	int size; 	/* size of data area in shared memory */
+	char* mem;	/* pointer to data area in shared memory */
 } DltShm;
 
 #define DLT_SHM_SEM_GET(id) dlt_shm_pv(id,-1)
 #define DLT_SHM_SEM_FREE(id) dlt_shm_pv(id,1)
 
+/**
+ * Initialise the shared memory on the client side.
+ * This function must be called before using further shm functions.
+ * @param buf pointer to shm structure
+ * @param key the identifier of the shm, must be the same for server and client
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_init_client(DltShm *buf,int key);
+
+/**
+ * Initialise the shared memory on the server side.
+ * This function must be called before using further shm functions.
+ * @param buf pointer to shm structure
+ * @param key the identifier of the shm, must be the same for server and client
+ * @param size the requested size of the shm
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_init_server(DltShm *buf,int key,int size);
 
+/**
+ * Push data from client onto the shm.
+ * @param buf pointer to shm structure
+ * @param data1 pointer to first data block to be written, null if not used
+ * @param size1 size in bytes of first data block to be written, 0 if not used
+ * @param data2 pointer to second data block to be written, null if not used
+ * @param size2 size in bytes of second data block to be written, 0 if not used
+ * @param data3 pointer to third data block to be written, null if not used
+ * @param size3 size in bytes of third data block to be written, 0 if not used
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_push(DltShm *buf,const unsigned char *data1,unsigned int size1,const unsigned char *data2,unsigned int size2,const unsigned char *data3,unsigned int size3);
+
+/**
+ * Pull data from shm.
+ * This function should be called from client.
+ * Data is deleted from shm after this call.
+ * @param buf pointer to shm structure
+ * @param data pointer to buffer where data is to be written
+ * @param size maximum size to be written into buffer
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_pull(DltShm *buf,unsigned char *data, int size);
+
+/**
+ * Copy message from shm.
+ * This function should be called from server.
+ * Data is not deleted from shm after this call.
+ * @param buf pointer to shm structure
+ * @param data pointer to buffer where data is to be written
+ * @param size maximum size to be written into buffer
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_copy(DltShm *buf,unsigned char *data, int size);
+
+/**
+ * Delete message from shm.
+ * This function should be called from server.
+ * This function should be called after each succesful copy.
+ * @param buf pointer to shm structure
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_remove(DltShm *buf);
 
+/**
+ * Print information about shm.
+ * @param buf pointer to shm structure
+ */
 extern void dlt_shm_info(DltShm *buf);
+
+/**
+ * Print status about shm.
+ * @param buf pointer to shm structure
+ */
 extern void dlt_shm_status(DltShm *buf);
 
+/**
+ * Deinitialise the shared memory on the client side.
+ * @param buf pointer to shm structure
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_free_client(DltShm *buf);
+
+/**
+ * Deinitialise the shared memory on the server side.
+ * @param buf pointer to shm structure
+ * @return negative value if there was an error
+ */
 extern int dlt_shm_free_server(DltShm *buf);
 
 #endif /* DLT_SHM_H */