Merge branch 'switch' into edge

[clinton/Smoothieware.git] / mri / mri.h

/* Copyright 2012 Adam Green (http://mbed.org/users/AdamGreen/)\r
\r
   This program is free software: you can redistribute it and/or modify\r
   it under the terms of the GNU Lesser General Public License as published\r
   by the Free Software Foundation, either version 3 of the License, or\r
   (at your option) any later version.\r
\r
   This program is distributed in the hope that it will be useful,\r
   but WITHOUT ANY WARRANTY; without even the implied warranty of\r
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
   GNU Lesser General Public License for more details.\r
\r
   You should have received a copy of the GNU Lesser General Public License\r
   along with this program.  If not, see <http://www.gnu.org/licenses/>.   \r
*/\r
/* Monitor for Remote Inspection. */\r
#ifndef _MRI_H_\r
#define _MRI_H_\r
\r
#include <stdint.h>\r
\r
/* Used to insert hardcoded breakpoint into user's code. */\r
#define __debugbreak()  do { __asm volatile ("bkpt #0"); } while (0)\r
\r
/* Error strings that can be returned to GDB. */\r
#define     MRI_ERROR_INVALID_ARGUMENT      "E01"   /* Encountered error when parsing command arguments. */\r
#define     MRI_ERROR_MEMORY_ACCESS_FAILURE "E03"   /* Couldn't access requested memory. */\r
#define     MRI_ERROR_BUFFER_OVERRUN        "E04"   /* Overflowed internal input/output buffer. */\r
#define     MRI_ERROR_NO_FREE_BREAKPOINT    "E05"   /* No free FPB breakpoint comparator slots. */\r
\r
\r
#ifdef __cplusplus\r
extern "C"\r
{\r
#endif\r
\r
\r
/* pDebuggerParameters string passed into __mriInit contains a space separated list of configuration parameters to be\r
   used to initialize the debug monitor.  The supported options include:\r
   \r
   One of these options to indicate which UART to be used for the debugger connection:\r
        MRI_UART_MBED_USB\r
        MRI_UART_MBED_P9_P10\r
        MRI_UART_MBED_P13_P14\r
        MRI_UART_MBED_P28_P27\r
        MRI_UART_0\r
        MRI_UART_1\r
        MRI_UART_2\r
        MRI_UART_3\r
        \r
    By default the debug monitor expects to take full control of the UART to configure baud rate, etc.  However \r
    including the following option will tell the monitor to assume that the user's firmware will configure and use the\r
    serial port until the first exception occurs:\r
        MRI_UART_SHARE\r
        \r
    When not sharing the UART, MRI will typically try to use the auto-baud functionality of the device so that the user\r
    can select the desired baud rate when they start GDB.  However it is possible to override this in the init string.\r
    For example the following option would set the baud rate to 230400 (note that spaces aren't allowed before or after\r
    the '=' character):\r
        MRI_UART_BAUD=230400\r
    NOTE: LPC176x version of MRI supports a maximum baud rate of 3Mbaud and the core clock can't run faster than\r
          128MHz or calculating baud rate divisors will fail.\r
*/\r
void __mriInit(const char* pDebuggerParameters);\r
\r
\r
/* Simple assembly language stubs that can be called from user's newlib stubs routines which will cause the operations\r
   to be redirected to the GDB host via MRI. */\r
int __mriNewLib_SemihostOpen(const char *pFilename, int flags, int mode);\r
int __mriNewLib_SemihostRename(const char *pOldFilename, const char *pNewFilename);\r
int __mriNewLib_SemihostUnlink(const char *pFilename);\r
int __mriNewLib_SemihostStat(const char *pFilename, void *pStat);\r
int __mriNewlib_SemihostWrite(int file, const char *ptr, int len);\r
int __mriNewlib_SemihostRead(int file, char *ptr, int len);\r
int __mriNewlib_SemihostLSeek(int file, int offset, int whence);\r
int __mriNewlib_SemihostClose(int file);\r
int __mriNewlib_SemihostFStat(int file, void *pStat);\r
\r
\r
\r
/* Can be used by semihosting hooks to determine the index of the UART being used by MRI. */\r
int __mriPlatform_CommUartIndex(void);\r
\r
\r
#ifdef __cplusplus\r
}\r
#endif\r
\r
#endif /* _MRI_H_ */\r
\r
\r
#ifndef MRI_VERSION_STRING\r
\r
#define MRI_BRANCH "https://github.com/adamgreen/mri/tree/version_0.5"\r
\r
#define MRI_VERSION_MAJOR       0\r
#define MRI_VERSION_MINOR       5\r
#define MRI_VERSION_BUILD       20130120\r
#define MRI_VERSION_SUBBUILD    1\r
\r
#define MRI_STR(X) MRI_STR2(X)\r
#define MRI_STR2(X) #X\r
\r
#define MRI_VERSION_STRING MRI_STR(MRI_VERSION_MAJOR) "." MRI_STR(MRI_VERSION_MINOR) "-" MRI_STR(MRI_VERSION_BUILD) "." MRI_STR(MRI_VERSION_SUBBUILD)\r
\r
#endif\r