4 * DSP-BIOS Bridge driver support functions for TI OMAP processors.
6 * DSP/BIOS Bridge msg_ctrl Module.
8 * Copyright (C) 2005-2006 Texas Instruments, Inc.
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.
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.
22 #include <dspbridge/devdefs.h>
23 #include <dspbridge/msgdefs.h>
26 * ======== msg_create ========
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
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.
37 * msg_mod_init(void) called.
40 * msg_callback != NULL.
43 extern int msg_create(struct msg_mgr **msg_man,
44 struct dev_object *hdev_obj,
45 msg_onexit msg_callback);
48 * ======== msg_delete ========
50 * Delete a msg_ctrl manager allocated in msg_create().
52 * hmsg_mgr: Handle returned from msg_create().
55 * msg_mod_init(void) called.
59 extern void msg_delete(struct msg_mgr *hmsg_mgr);
62 * ======== msg_exit ========
64 * Discontinue usage of msg_ctrl module.
68 * msg_mod_init(void) successfully called before.
70 * Any resources acquired in msg_mod_init(void) will be freed when last
71 * msg_ctrl client calls msg_exit(void).
73 extern void msg_exit(void);
76 * ======== msg_mod_init ========
78 * Initialize the msg_ctrl module.
81 * TRUE if initialization succeeded, FALSE otherwise.
84 extern bool msg_mod_init(void);