KM3NeT CLB  2.0
KM3NeT CLB v2 Embedded Software
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
runtime.h
Go to the documentation of this file.
1 /*
2  * KM3NeT CLB v2 Firmware
3  * ----------------------
4  *
5  * Copyright 2012-2014 KM3NeT Collaboration
6  *
7  * All Rights Reserved.
8  *
9  *
10  * File : runtime.h
11  * Created : 26 nov. 2014
12  * Author : Vincent van Beveren
13  */
14 
15 /**
16  * @file
17  *
18  * @ingroup app
19  *
20  * Provides access to the runtime image booting.
21  *
22  * @note may be an intermediate module, and removed later on. Not happy with it.
23  */
24 
25 #ifndef RUNTIME_H_
26 #define RUNTIME_H_
27 
28 #include <stdbool.h>
29 #include <stdint.h>
30 
31 #define RT_DEFAULT_IMAGE 1
32 
33 /**
34  * Returns the image loaded for runtime.
35  *
36  * @return Boot image number (0..3).
37  */
38 int rtImage();
39 
40 
41 /**
42  * Sets the runtime boot image number.
43  *
44  * @param imgNo Boot image number (0..3).
45  *
46  * @retval True Image set succesfully
47  * @retval False Image set failed, check error module.
48  */
49 bool rtSetImage(int imgNo);
50 
51 #endif /* RUNTIME_H_ */
int rtImage()
Returns the image loaded for runtime.
Definition: runtime.c:59
bool rtSetImage(int imgNo)
Sets the runtime boot image number.
Definition: runtime.c:66