cleanup before merging

[clinton/Smoothieware.git] / gcc4mbed / src / syscalls.c

/* Copyright 2011 Adam Green (http://mbed.org/users/AdamGreen/)\r
\r
   Licensed under the Apache License, Version 2.0 (the "License");\r
   you may not use this file except in compliance with the License.\r
   You may obtain a copy of the License at\r
\r
       http://www.apache.org/licenses/LICENSE-2.0\r
\r
   Unless required by applicable law or agreed to in writing, software\r
   distributed under the License is distributed on an "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
   See the License for the specific language governing permissions and\r
   limitations under the License.\r
*/\r
/* System calls called out as overrideable in newlib documentation which weren't implemented follow in this list\r
   with reason:\r
   \r
    environ         Not required.  getenv() and setenv() can be used without providing an override as there is a default\r
    _execve         Standard C APIs implemented by newlib don't end up calling this function.  Implemented _system\r
                    instead.\r
    _fork           Standard C APIs implemented by newlib don't end up calling this function.  Implemented _system\r
                    instead.\r
    _link           This is a POSIX routine and while newlib will call it for the standard C rename() function, this\r
                    particular routine is overridden in mbed.ar where it just returns -1.\r
    _stat           This is a system API and not part of the C standard.  It doesn't appear to be required for mbed.\r
    _times          Appears to be a system API and not part of the C standard.  Not called from standard APIs.\r
    _unlink         This is a POSIX routine.  newlib will call it for standard C remove(), this particular API is\r
                    already overidden by mbed.ar\r
*/\r
#include <reent.h>\r
#include <errno.h>\r
#include <stdlib.h> /* abort */\r
#include <sys/types.h>\r
#include <sys/stat.h>\r
#include <sys/_default_fcntl.h>\r
#include "LPC17xx.h" /* for _get_*SP() from core_cm3.h*/\r
#include "mbedsys.h" /* for _sys_*() functions implemented in mbed/capi.ar */\r
#include "error.h"   /* for error() panic routine */\r
\r
\r
#undef errno\r
extern int errno;\r
\r
\r
/* Flag used to track whether the stdin/stdout/stderr handles have been opened yet */\r
static int g_StandardHandlesOpened = 0;\r
\r
\r
/* Open the stdin/stdout/stderr handles */\r
extern "C" void __GCC4MBEDOpenStandardHandles(void)\r
{\r
    /* Open stdin/stdout/stderr */\r
    _sys_open("/stdin", OPENMODE_R);\r
    _sys_open("/stdout", OPENMODE_W);\r
    _sys_open("/stderr", OPENMODE_W);\r
    \r
    g_StandardHandlesOpened = 1;\r
}    \r
\r
\r
extern "C" int _kill(int pid, int sig)\r
{\r
    /* Avoid warnings */\r
    (void)pid;\r
    (void)sig;\r
\r
	errno = EINVAL;\r
	return -1;\r
}\r
\r
extern "C" void _exit(int status)\r
{\r
    /* Call the mbed version of exit found in capi.ar */\r
    exit(status);\r
}\r
\r
extern "C" int _getpid(void)\r
{\r
	return 1;\r
}\r
\r
\r
extern char _end; /* Defined by the linker */\r
static char *heap_end;\r
\r
static char* get_stack_top(void)\r
{\r
	return (char*) __get_MSP();\r
}\r
\r
extern "C" caddr_t _sbrk(int incr)\r
{\r
	char *prev_heap_end;\r
	if (heap_end == 0) {\r
		heap_end = &_end;\r
	}\r
	prev_heap_end = heap_end;\r
	if (heap_end + incr > get_stack_top()) {\r
		\r
		abort();\r
	}\r
	heap_end += incr;\r
	return (caddr_t) prev_heap_end;\r
}\r
\r
extern "C" int _open(const char *name, int flags, int mode) \r
{\r
    int OpenMode = 0;\r
    \r
    (void)mode;\r
    \r
    /* Convert from newlib flags to mbed openmode */\r
    if (flags & O_RDWR)\r
    {\r
        OpenMode |= OPENMODE_PLUS;\r
    }\r
    if (flags & O_TRUNC)\r
    {\r
        OpenMode |= OPENMODE_W;\r
    }\r
    if (flags & O_APPEND)\r
    {\r
        OpenMode |= OPENMODE_A;\r
    }\r
\r
    return _sys_open(name, OpenMode);\r
}\r
\r
extern "C" int _close(int file)\r
{\r
	return _sys_close(file);\r
}\r
\r
extern "C" int _isatty(int file)\r
{\r
    /* Hardcoding the stdin/stdout/stderr handles to be interactive tty devices, unlike mbed.ar */\r
    if (file < 3)\r
    {\r
        return 1;\r
    }\r
\r
    return _sys_istty(file);\r
}\r
\r
/* TODO: Remove this later when _lseek no longer requires it */\r
static unsigned short _crc16(const unsigned char* pBuffer, size_t BufferSizeInBytes)\r
{\r
    unsigned short  CRC = 0;\r
    \r
    while (BufferSizeInBytes--)\r
    {\r
        unsigned short  Byte = (unsigned short)*pBuffer++;\r
        int             i;\r
\r
        for (i = 0 ; i < 8 ; i++)\r
        {\r
            unsigned short Value = (Byte ^ CRC) & 1;\r
            CRC >>= 1;\r
            if (Value)\r
            {\r
                CRC ^= 0xA001;\r
            }\r
            Byte >>= 1;\r
        }\r
    }\r
    \r
    return ~CRC;\r
}\r
    \r
extern "C" int _lseek(int file, int ptr, int dir) \r
{\r
    /* Function pointer type for the FileHandle::lseek() method */\r
    typedef int (*lseekMethod)(void* pThis, int ptr, int dir);\r
    static const unsigned short ExpectedSysSeekCRC = 0xDFC0;\r
    static lseekMethod***       pppFileHandles = NULL;\r
    lseekMethod**               ppFileHandle;\r
    lseekMethod*                pFileHandleVTable;\r
    lseekMethod                 FileHandle_lseekMethod;\r
    \r
    /* When file is set to 0, 1, or 2 then the file is actually a standard I/O stream so just return 0 since they\r
       don't really support seeking and this is what _sys_seek() does as well */\r
    if (file < 3)\r
    {\r
        return 0;\r
    }\r
    \r
    /* Find the location of the filehandles array if we haven't already */\r
    if (!pppFileHandles)\r
    {\r
        /* TODO: This code is pretty hacky but it is the only way I can get things to work with mbed.ar at this time.\r
                 If the mbed crew could make a small change to their library such that they exposed something equivalent\r
                 to _sys_lseek in addition to their _sys_seek then both this _lseek function and their _sys_seek could \r
                 call it to perform seeks using any seek direction (whence) value */\r
        unsigned short*       pSysSeek;\r
        unsigned short        CRC;\r
    \r
        /* Grab a pointer to where the _sys_seek code ends up being loaded for this program */\r
        pSysSeek = (unsigned short*)((unsigned int)_sys_seek & ~1);\r
    \r
        /* Perform a CRC over the first 40 bytes which contain PC-relative code for the _sys_seek function to\r
           make sure that it hasn't changed from when I figured out the location of the pointer used for\r
           dereferencing into the 16 element filehandles static array from stdio.cpp */\r
        CRC = _crc16((unsigned char*)pSysSeek, 40);\r
        if (ExpectedSysSeekCRC != CRC)\r
        {\r
            error("RIP: _sys_seek() in mbed.ar has been modified\r\n"\r
                  "     and _lseek in gcc4mbed/syscalls.c needs to be updated\r\n");\r
        }\r
        \r
        /* I know that the pointer for the filehandles array is stored as a literal 20 shorts after the beginning of the \r
           _sys_seek() function */\r
        pppFileHandles = (lseekMethod***)*(void**)(void*)(pSysSeek + 20);\r
    }\r
\r
    \r
    /* Find the pointer to the FileHandle object representing this file */\r
    ppFileHandle = pppFileHandles[file - 3];\r
    if (!ppFileHandle)\r
    {\r
        /* The file handle isn't valid */\r
        return -1;\r
    }\r
    \r
    /* The vtable for this FileHandle object will be stored in the first 4-byte word of the object */\r
    pFileHandleVTable = *ppFileHandle;\r
    \r
    /* The fifth element of this vtable is the pointer to the lseek method */\r
    FileHandle_lseekMethod = pFileHandleVTable[4];\r
    \r
    /* Finally call into the file handle object's seek method */\r
    return FileHandle_lseekMethod(ppFileHandle, ptr, dir);\r
}\r
\r
extern "C" int _read(int file, char *ptr, int len)\r
{\r
    int BytesNotRead;\r
    \r
    /* Open stdin/stdout/stderr if needed */\r
    if (!g_StandardHandlesOpened && file < 3)\r
    {\r
        __GCC4MBEDOpenStandardHandles();\r
    }\r
\r
    /* Call the function in mbed.ar and let it handle the read */\r
    BytesNotRead = _sys_read(file, (unsigned char*)ptr, len, 0);\r
    \r
    /* EOF is indicated by setting the most significant bit so mask it off */\r
    BytesNotRead &= 0x7FFFFFFF;\r
\r
    /* The mbed version of the function returns bytes not read and newlib wants bytes read count */\r
    return len - BytesNotRead;\r
}\r
\r
extern "C" int _write(int file, char *ptr, int len)\r
{\r
    int BytesNotWritten;\r
    \r
    /* Open stdin/stdout/stderr if needed */\r
    if (!g_StandardHandlesOpened && file < 3)\r
    {\r
        __GCC4MBEDOpenStandardHandles();\r
    }\r
\r
    /* Call the function in mbed.ar and let it handle the writes */\r
    BytesNotWritten = _sys_write(file, (const unsigned char*)ptr, len, 0);\r
    \r
    /* The mbed version of the function returns bytes not written and newlib wants byte written count */\r
    if (BytesNotWritten >= 0)\r
    {\r
        return len - BytesNotWritten;\r
    }\r
    else\r
    {\r
        /* In this case it did return an error */\r
        return BytesNotWritten;\r
    }\r
}\r
\r
extern "C" int _fstat(int file, struct stat *st)\r
{\r
	(void)file;\r
\r
	st->st_mode = S_IFCHR;\r
	return 0;\r
}\r
\r
extern "C" int _system(const char* pCommand)\r
{\r
    if (NULL == pCommand)\r
    {\r
        /* There is no command interpreter on the mbed */\r
        return 0;\r
    }\r
    else\r
    {\r
        /* Indicate that command couldn't be executed since there is no command interpreter */\r
        errno = ENOENT;\r
        return -1;\r
    }\r
}\r