First version
[3rdparty/ote_partner/tlk.git] / include / app.h
1 /*
2  * Copyright (c) 2009-2012 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23 #ifndef __APP_H
24 #define __APP_H
25
26 #include <stddef.h>
27
28 /* app support api */
29 void apps_init(void); /* one time setup */
30
31 /* app entry point */
32 struct app_descriptor;
33 typedef void (*app_init)(const struct app_descriptor *);
34 typedef void (*app_entry)(const struct app_descriptor *, void *args);
35
36 /* app startup flags */
37 #define APP_FLAG_DONT_START_ON_BOOT 0x1
38 #define APP_FLAG_CUSTOM_STACK_SIZE 0x2
39
40 /* each app needs to define one of these to define its startup conditions */
41 struct app_descriptor {
42         const char *name;
43         app_init  init;
44         app_entry entry;
45         unsigned int flags;
46         size_t stack_size;
47 };
48
49 #define APP_START(appname) struct app_descriptor _app_##appname __SECTION(".apps") = { .name = #appname,
50 #define APP_END };
51
52 #endif
53