bankmem.h

Go to the documentation of this file.
00001 #ifndef _SYS_BANKMEM_H_
00002 #define _SYS_BANKMEM_H_
00003 
00004 /*
00005  * Copyright (C) 2003-2005 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  *
00035  */
00036 
00065 #include <sys/types.h>
00066 #include <stdint.h>
00067 #include <cfg/bankmem.h>
00068 
00074 #ifndef NUTBANK_COUNT
00075 /*
00076  * Arrrgh! I hate this. OK, on one hand the code is not
00077  * spoiled by ifdefs, but this one is sooouuu ugly.
00078  */
00079 #define NUTBANK_COUNT   0
00080 #endif
00081 
00082 #if NUTBANK_COUNT
00083 
00084 #ifdef ARTHERNET1
00085 /* Arthernet uses a different banking. */
00086 #define NutSegBufEnable(bank) *(volatile uint8_t *)(NUTBANK_SR) = (((uint8_t)bank+1)<<4)
00087 #elif MMNET02
00088 /* MMnet02 uses a different banking. */
00089 #define NutSegBufEnable(bank) *((char *)(NUTBANK_SR)) = (bank)
00090 #else
00091 /* This is the Ethernut way. */
00092 #define NutSegBufEnable(bank) *((char *)(NUTBANK_SR) + (bank)) = (bank)
00093 #endif
00094 
00095 #else
00096 /* No banked memory. */
00097 #define NutSegBufEnable(bank)
00098 #endif
00099 
00100 
00101 __BEGIN_DECLS
00102 /* Prototypes */
00103 extern char *NutSegBufReset(void);
00104 extern char *NutSegBufInit(size_t size);
00105 extern char *NutSegBufWriteRequest(size_t * bcp);
00106 extern char *NutSegBufReadRequest(size_t * bcp);
00107 extern char *NutSegBufWriteCommit(size_t bc);
00108 extern char *NutSegBufReadCommit(size_t bc);
00109 extern void NutSegBufWriteLast(size_t bc);
00110 extern void NutSegBufReadLast(size_t bc);
00111 extern uint32_t NutSegBufAvailable(void);
00112 extern uint32_t NutSegBufUsed(void);
00113 /* */
00114 __END_DECLS
00115 #endif

© 2000-2007 by egnite Software GmbH - visit http://www.ethernut.de/