Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
msg.h
Go to the documentation of this file.
1 /*
2  * msg.h
3  *
4  * DSP-BIOS Bridge driver support functions for TI OMAP processors.
5  *
6  * DSP/BIOS Bridge msg_ctrl Module.
7  *
8  * Copyright (C) 2005-2006 Texas Instruments, Inc.
9  *
10  * This package is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  *
14  * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
16  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
17  */
18 
19 #ifndef MSG_
20 #define MSG_
21 
22 #include <dspbridge/devdefs.h>
23 #include <dspbridge/msgdefs.h>
24 
25 /*
26  * ======== msg_create ========
27  * Purpose:
28  * Create an object to manage message queues. Only one of these objects
29  * can exist per device object. The msg_ctrl manager must be created before
30  * the IO Manager.
31  * Parameters:
32  * msg_man: Location to store msg_ctrl manager handle on output.
33  * hdev_obj: The device object.
34  * msg_callback: Called whenever an RMS_EXIT message is received.
35  * Returns:
36  * Requires:
37  * msg_man != NULL.
38  * hdev_obj != NULL.
39  * msg_callback != NULL.
40  * Ensures:
41  */
42 extern int msg_create(struct msg_mgr **msg_man,
43  struct dev_object *hdev_obj,
44  msg_onexit msg_callback);
45 
46 /*
47  * ======== msg_delete ========
48  * Purpose:
49  * Delete a msg_ctrl manager allocated in msg_create().
50  * Parameters:
51  * hmsg_mgr: Handle returned from msg_create().
52  * Returns:
53  * Requires:
54  * Valid hmsg_mgr.
55  * Ensures:
56  */
57 extern void msg_delete(struct msg_mgr *hmsg_mgr);
58 
59 #endif /* MSG_ */