Merge pull request #27 from logxen/xhume
[clinton/Smoothieware.git] / gcc4mbed / mri / mri.h
CommitLineData
6c79da43 1/* Copyright 2012 Adam Green (http://mbed.org/users/AdamGreen/)\r
3c132bd0 2\r
6c79da43
AG
3 Licensed under the Apache License, Version 2.0 (the "License");\r
4 you may not use this file except in compliance with the License.\r
5 You may obtain a copy of the License at\r
3c132bd0 6\r
6c79da43 7 http://www.apache.org/licenses/LICENSE-2.0\r
3c132bd0 8\r
6c79da43
AG
9 Unless required by applicable law or agreed to in writing, software\r
10 distributed under the License is distributed on an "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
12 See the License for the specific language governing permissions and\r
13 limitations under the License.\r
3c132bd0
AW
14*/\r
15/* Monitor for Remote Inspection header file. */\r
16#ifndef _MRI_H_\r
17#define _MRI_H_\r
18\r
6c79da43
AG
19#include <stdint.h>\r
20\r
21/* Used to insert hardcoded breakpoint into user's code. */\r
3c132bd0
AW
22#define __debugbreak() { __asm volatile ("bkpt #0"); }\r
23\r
6c79da43
AG
24#ifdef __cplusplus\r
25extern "C"\r
26{\r
27#endif\r
28\r
29\r
30/* pDebuggerParameters string passed into __mriInit contains a space separated list of configuration parameters to be\r
31 used to initialize the debug monitor. The supported options include:\r
32 \r
33 One of these options to indicate which UART to be used for the debugger connection:\r
34 MRI_UART_MBED_USB\r
35 MRI_UART_MBED_P9_P10\r
36 MRI_UART_MBED_P13_P14\r
37 MRI_UART_MBED_P28_P27\r
38 \r
39 By default the debug monitor expects to take full control of the UART to configure baud rate, etc. However \r
40 including the following option will tell the monitor to assume that the user's firmware will configure and use the\r
41 serial port until the first exception occurs:\r
42 MRI_UART_SHARE\r
43 \r
44*/\r
45void __mriInit(const char* pDebuggerParameters);\r
46\r
47\r
48#ifdef __cplusplus\r
49}\r
50#endif\r
51\r
3c132bd0 52#endif /* _MRI_H_ */\r