├── sample ├── spidev-testc.c └── spidev-testcpp.cc ├── CMakeLists.txt ├── README.md ├── src ├── spidev_lib.h ├── spidev_lib++.h ├── spidev_lib.c └── spidev_lib++.cc └── LICENSE /sample/spidev-testc.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | spi_config_t spi_config; 7 | uint8_t tx_buffer[32]; 8 | uint8_t rx_buffer[32]; 9 | 10 | 11 | void main( void) 12 | { 13 | int spifd; 14 | spi_config.mode=0; 15 | spi_config.speed=1000000; 16 | spi_config.delay=0; 17 | spi_config.bits_per_word=8; 18 | 19 | spifd=spi_open("/dev/spidev2.0",spi_config); 20 | 21 | memset(tx_buffer,0,32); 22 | memset(rx_buffer,0,32); 23 | sprintf(tx_buffer,"hello world"); 24 | printf("sending %s, to spidev2.0 in full duplex \n ",tx_buffer); 25 | spi_xfer(spifd,tx_buffer,strlen(tx_buffer),rx_buffer,strlen(tx_buffer)); 26 | printf("rx_buffer=%s\n",rx_buffer); 27 | spi_close(spifd); 28 | } 29 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 2.6) 2 | 3 | project(spidev-lib) 4 | set(CMAKE_CXX_FLAGS "-g -Wall") 5 | set(CMAKE_C_FLAGS "-g -Wall") 6 | 7 | include_directories(src/) 8 | 9 | 10 | add_library(spidev-lib src/spidev_lib.c) 11 | add_executable( 12 | spi-testc sample/spidev-testc.c 13 | ) 14 | target_link_libraries( spi-testc spidev-lib) 15 | 16 | add_library(spidev-lib++ src/spidev_lib++.cc) 17 | add_executable(spi-testcpp sample/spidev-testcpp.cc) 18 | target_link_libraries( spi-testcpp spidev-lib++ ) 19 | 20 | add_dependencies(spi-testcpp spidev-lib++) 21 | add_dependencies(spi-testc spidev-lib) 22 | 23 | INSTALL(TARGETS spidev-lib spidev-lib++ 24 | RUNTIME DESTINATION bin 25 | LIBRARY DESTINATION lib 26 | ARCHIVE DESTINATION lib 27 | ) 28 | INSTALL( FILES src/spidev_lib.h DESTINATION include) 29 | INSTALL( FILES src/spidev_lib++.h DESTINATION include) 30 | 31 | -------------------------------------------------------------------------------- /sample/spidev-testcpp.cc: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include 4 | #include 5 | 6 | spi_config_t spi_config; 7 | uint8_t tx_buffer[32]; 8 | uint8_t rx_buffer[32]; 9 | 10 | 11 | int main( void) 12 | { 13 | 14 | SPI *mySPI = NULL; 15 | 16 | spi_config.mode=0; 17 | spi_config.speed=1000000; 18 | spi_config.delay=0; 19 | spi_config.bits_per_word=8; 20 | 21 | mySPI=new SPI("/dev/spidev1.0",&spi_config); 22 | 23 | if (mySPI->begin()) 24 | { 25 | memset(tx_buffer,0,32); 26 | memset(rx_buffer,0,32); 27 | sprintf((char*)tx_buffer,"hello world"); 28 | printf("sending %s, to spidev2.0 in full duplex \n ",(char*)tx_buffer); 29 | mySPI->xfer(tx_buffer,strlen((char*)tx_buffer),rx_buffer,strlen((char*)tx_buffer)); 30 | printf("rx_buffer=%s\n",(char *)rx_buffer); 31 | //mySPI->end(); 32 | delete mySPI; 33 | } 34 | return 1; 35 | } 36 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Introduction: 2 | ------------- 3 | This package provide C/C++ lib wrapper to linux user space spidev 4 | This pacakage is based on work done by Stefan Mavrodiev 5 | for the pyA20 python library https://pypi.python.org/pypi/pyA20 6 | 7 | 8 | Warning 9 | ------- 10 | if you want other user than root have access to spidev device you may probably need to add a file with the following udev rules in your /etc/udev.d directory. 11 | 12 | KERNEL=="spidev*", SUBSYSTEM=="spidev", GROUP="spi", MODE="0660" 13 | 14 | add a spi groups and add user to this groups 15 | 16 | How to build 17 | ------------ 18 | 19 | First of all you need cmake installed on your system. 20 | into main directory do the following: 21 | 22 | * mkdir build 23 | * cd build 24 | * cmake ../ 25 | * make 26 | * make install 27 | 28 | This will create 2 statics libraries libspidev-lib.a and libspidev-lib++.a 29 | You can link thoses libraries against your own code. 30 | 31 | The sample directory contain a sample usage for c and for c++ 32 | you can compile it from main directory in this way. 33 | 34 | * g++ sample/spidev-testcpp.cc -lspidev-lib++ -o spidev-testcpp 35 | * gcc sample/spidev-testc.c -lspidev-lib -o spidev-testc 36 | 37 | if you have any question you can contact me at lemouchon at gmail dot com. 38 | -------------------------------------------------------------------------------- /src/spidev_lib.h: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * This file is part of pyA20. 4 | * spi_lib.c is python SPI extension. 5 | * 6 | * Copyright (c) 2014 Stefan Mavrodiev @ OLIMEX LTD, 7 | * 8 | * pyA20 is free software; you can redistribute it and/or modify 9 | * it under the terms of the GNU General Public License as published by 10 | * the Free Software Foundation; either version 2 of the License, or 11 | * (at your option) any later version. 12 | * 13 | * This program is distributed in the hope that it will be useful, 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | * GNU General Public License for more details. 17 | * 18 | * You should have received a copy of the GNU General Public License 19 | * along with this program; if not, write to the Free Software 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 21 | * MA 02110-1301, USA. 22 | */ 23 | 24 | #ifndef _SPI_LIB_H 25 | #define _SPI_LIB_H 26 | #endif 27 | 28 | #include 29 | #ifdef __cplusplus 30 | extern "C" { 31 | #endif 32 | 33 | typedef struct { 34 | uint8_t mode; 35 | uint8_t bits_per_word; 36 | uint32_t speed; 37 | uint16_t delay; 38 | } spi_config_t; 39 | 40 | int spi_open(char *device, spi_config_t config); 41 | int spi_close(int fd); 42 | int spi_xfer(int fd, uint8_t *tx_buffer, uint8_t tx_len, uint8_t *rx_buffer, uint8_t rx_len); 43 | int spi_read(int fd, uint8_t *rx_buffer, uint8_t rx_len); 44 | int spi_write(int fd, uint8_t *tx_buffer, uint8_t tx_len); 45 | #ifdef __cplusplus 46 | } 47 | #endif 48 | 49 | 50 | 51 | 52 | -------------------------------------------------------------------------------- /src/spidev_lib++.h: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * Copyright (c) 2014 Philippe Van Hecke 4 | * 5 | * you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation; either version 2 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program; if not, write to the Free Software 17 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 18 | * MA 02110-1301, USA. 19 | */ 20 | 21 | #ifndef _SPI_LIB_HPP 22 | #define _SPI_LIB_HPP 23 | #endif 24 | 25 | #include 26 | #ifdef __cplusplus 27 | extern "C" { 28 | #endif 29 | 30 | typedef struct { 31 | uint8_t mode; 32 | uint8_t bits_per_word; 33 | uint32_t speed; 34 | uint16_t delay; 35 | } spi_config_t; 36 | 37 | #ifdef __cplusplus 38 | } 39 | #endif 40 | 41 | //class SPI{ 42 | //public: 43 | #ifdef __cplusplus 44 | class SPI{ 45 | private: 46 | char *m_spidev; 47 | int m_spifd; 48 | spi_config_t m_spiconfig; 49 | bool m_open; 50 | public: 51 | SPI(const char * p_spidev); 52 | SPI(const char * p_spidev, spi_config_t *p_spi_config); 53 | ~SPI(); 54 | bool begin(); 55 | bool end(); 56 | int read(uint8_t *p_rxbuffer,uint8_t p_rxlen); 57 | int write(uint8_t *p_txbuffer,uint8_t p_txlen); 58 | int xfer(uint8_t *p_txbuffer, uint8_t p_txlen, uint8_t *p_rxbuffer, uint8_t p_rxlen); 59 | bool setSpeed(uint32_t p_speed); 60 | bool setMode(uint8_t p_mode); 61 | bool setBitPerWord(uint8_t p_bit); 62 | bool setConfig(spi_config_t *p_spi_config); 63 | 64 | }; 65 | 66 | #endif 67 | 68 | 69 | 70 | 71 | 72 | -------------------------------------------------------------------------------- /src/spidev_lib.c: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * This file is based on of pyA20. 4 | * spi_lib.c python SPI extension. 5 | * 6 | * Copyright (c) 2014 Stefan Mavrodiev @ OLIMEX LTD, 7 | * 8 | * pyA20 is free software; you can redistribute it and/or modify 9 | * it under the terms of the GNU General Public License as published by 10 | * the Free Software Foundation; either version 2 of the License, or 11 | * (at your option) any later version. 12 | * 13 | * This program is distributed in the hope that it will be useful, 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | * GNU General Public License for more details. 17 | * 18 | * You should have received a copy of the GNU General Public License 19 | * along with this program; if not, write to the Free Software 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 21 | * MA 02110-1301, USA. 22 | * Adpated by Philippe Van Hecke 23 | */ 24 | 25 | 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | 35 | #include 36 | 37 | #include "spidev_lib.h" 38 | 39 | int spi_open(char *device, spi_config_t config) { 40 | int fd; 41 | 42 | /* Open block device */ 43 | fd = open(device, O_RDWR); 44 | if (fd < 0) { 45 | return fd; 46 | } 47 | 48 | /* Set SPI_POL and SPI_PHA */ 49 | if (ioctl(fd, SPI_IOC_WR_MODE, &config.mode) < 0) { 50 | return -1; 51 | } 52 | if (ioctl(fd, SPI_IOC_RD_MODE, &config.mode) < 0) { 53 | return -1; 54 | } 55 | 56 | /* Set bits per word*/ 57 | if (ioctl(fd, SPI_IOC_WR_BITS_PER_WORD, &config.bits_per_word) < 0) { 58 | return -1; 59 | } 60 | if (ioctl(fd, SPI_IOC_RD_BITS_PER_WORD, &config.bits_per_word) < 0) { 61 | return -1; 62 | } 63 | 64 | /* Set SPI speed*/ 65 | if (ioctl(fd, SPI_IOC_WR_MAX_SPEED_HZ, &config.speed) < 0) { 66 | return -1; 67 | } 68 | if (ioctl(fd, SPI_IOC_RD_MAX_SPEED_HZ, &config.speed) < 0) { 69 | return -1; 70 | } 71 | 72 | /* Return file descriptor */ 73 | return fd; 74 | } 75 | 76 | int spi_close(int fd) { 77 | return close(fd); 78 | } 79 | 80 | int spi_xfer(int fd, uint8_t *tx_buffer, uint8_t tx_len, uint8_t *rx_buffer, uint8_t rx_len){ 81 | struct spi_ioc_transfer spi_message[1]; 82 | memset(spi_message, 0, sizeof(spi_message)); 83 | 84 | spi_message[0].rx_buf = (unsigned long)rx_buffer; 85 | spi_message[0].tx_buf = (unsigned long)tx_buffer; 86 | spi_message[0].len = tx_len; 87 | 88 | return ioctl(fd, SPI_IOC_MESSAGE(1), spi_message); 89 | } 90 | 91 | int spi_read(int fd, uint8_t *rx_buffer, uint8_t rx_len){ 92 | struct spi_ioc_transfer spi_message[1]; 93 | memset(spi_message, 0, sizeof(spi_message)); 94 | 95 | spi_message[0].rx_buf = (unsigned long)rx_buffer; 96 | spi_message[0].len = rx_len; 97 | 98 | 99 | return ioctl(fd, SPI_IOC_MESSAGE(1), spi_message); 100 | } 101 | 102 | int spi_write(int fd, uint8_t *tx_buffer, uint8_t tx_len){ 103 | struct spi_ioc_transfer spi_message[1]; 104 | memset(spi_message, 0, sizeof(spi_message)); 105 | 106 | spi_message[0].tx_buf = (unsigned long)tx_buffer; 107 | spi_message[0].len = tx_len; 108 | 109 | return ioctl(fd, SPI_IOC_MESSAGE(1), spi_message); 110 | } 111 | 112 | 113 | -------------------------------------------------------------------------------- /src/spidev_lib++.cc: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2014 Philippe Van Hecke 3 | * 4 | * pyA20 is free software; you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation; either version 2 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program; if not, write to the Free Software 16 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 17 | * MA 02110-1301, USA. 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | #include 30 | 31 | #include "spidev_lib++.h" 32 | 33 | 34 | bool SPI::setBitPerWord(uint8_t p_bit){ 35 | 36 | /* Set bits per word*/ 37 | if (ioctl(m_spifd, SPI_IOC_WR_BITS_PER_WORD, &p_bit) < 0) { 38 | return false; 39 | } 40 | if (ioctl(m_spifd, SPI_IOC_RD_BITS_PER_WORD, &p_bit) < 0) { 41 | return false; 42 | } 43 | 44 | m_spiconfig.bits_per_word = p_bit; 45 | return true; 46 | 47 | } 48 | bool SPI::setSpeed(uint32_t p_speed){ 49 | /* Set SPI speed*/ 50 | if (ioctl(m_spifd, SPI_IOC_WR_MAX_SPEED_HZ, &p_speed) < 0) { 51 | return false; 52 | } 53 | if (ioctl(m_spifd, SPI_IOC_RD_MAX_SPEED_HZ, &p_speed) < 0) { 54 | return false; 55 | } 56 | 57 | m_spiconfig.speed = p_speed; 58 | 59 | return true; 60 | 61 | 62 | } 63 | 64 | bool SPI::setMode(uint8_t p_mode){ 65 | /* Set SPI_POL and SPI_PHA */ 66 | if (ioctl(m_spifd, SPI_IOC_WR_MODE, &p_mode) < 0) { 67 | return false; 68 | } 69 | if (ioctl(m_spifd, SPI_IOC_RD_MODE, &p_mode) < 0) { 70 | return false; 71 | } 72 | 73 | m_spiconfig.mode = p_mode; 74 | return true; 75 | 76 | 77 | } 78 | 79 | int SPI::xfer(uint8_t *p_txbuffer, uint8_t p_txlen, uint8_t *p_rxbuffer, uint8_t p_rxlen){ 80 | struct spi_ioc_transfer spi_message[1]; 81 | memset(spi_message, 0, sizeof(spi_message)); 82 | 83 | spi_message[0].rx_buf = (unsigned long)p_rxbuffer; 84 | spi_message[0].tx_buf = (unsigned long)p_txbuffer; 85 | spi_message[0].len = p_txlen; 86 | return ioctl(m_spifd, SPI_IOC_MESSAGE(1), spi_message); 87 | } 88 | 89 | int SPI::write(uint8_t *p_txbuffer,uint8_t p_txlen){ 90 | struct spi_ioc_transfer spi_message[1]; 91 | memset(spi_message, 0, sizeof(spi_message)); 92 | spi_message[0].tx_buf = (unsigned long)p_txbuffer; 93 | spi_message[0].len = p_txlen; 94 | 95 | return ioctl(m_spifd, SPI_IOC_MESSAGE(1), spi_message); 96 | 97 | } 98 | 99 | int SPI::read(uint8_t *p_rxbuffer,uint8_t p_rxlen){ 100 | struct spi_ioc_transfer spi_message[1]; 101 | memset(spi_message, 0, sizeof(spi_message)); 102 | 103 | spi_message[0].rx_buf = (unsigned long)p_rxbuffer; 104 | spi_message[0].len = p_rxlen; 105 | return ioctl(m_spifd, SPI_IOC_MESSAGE(1), spi_message); 106 | } 107 | 108 | bool SPI::begin(){ 109 | /* open spidev device */ 110 | if (m_open == true ) 111 | return true; 112 | if (m_spidev == NULL) 113 | return false; 114 | m_spifd = open(m_spidev, O_RDWR); 115 | 116 | if (m_spifd < 0) { 117 | return false; 118 | } 119 | /* Set SPI_POL and SPI_PHA */ 120 | if (ioctl(m_spifd, SPI_IOC_WR_MODE, &m_spiconfig.mode) < 0) { 121 | close(m_spifd); 122 | return false; 123 | } 124 | if (ioctl(m_spifd, SPI_IOC_RD_MODE, &m_spiconfig.mode) < 0) { 125 | close(m_spifd); 126 | return false; 127 | } 128 | 129 | /* Set bits per word*/ 130 | if (ioctl(m_spifd, SPI_IOC_WR_BITS_PER_WORD, &m_spiconfig.bits_per_word) < 0) { 131 | close(m_spifd); 132 | return false; 133 | } 134 | if (ioctl(m_spifd, SPI_IOC_RD_BITS_PER_WORD, &m_spiconfig.bits_per_word) < 0) { 135 | close(m_spifd); 136 | return false; 137 | } 138 | 139 | /* Set SPI speed*/ 140 | if (ioctl(m_spifd, SPI_IOC_WR_MAX_SPEED_HZ, &m_spiconfig.speed) < 0) { 141 | close(m_spifd); 142 | return false; 143 | } 144 | if (ioctl(m_spifd, SPI_IOC_RD_MAX_SPEED_HZ, &m_spiconfig.speed) < 0) { 145 | close(m_spifd); 146 | return false; 147 | } 148 | 149 | m_open = true; 150 | 151 | return true; 152 | 153 | 154 | } 155 | SPI::SPI(const char * p_spidev){ 156 | m_spidev = NULL; 157 | if (p_spidev != NULL ){ 158 | m_spidev = (char *)malloc(strlen(p_spidev)+1); 159 | if (m_spidev != NULL) 160 | strcpy(m_spidev,p_spidev); 161 | } 162 | m_open = false; 163 | 164 | } 165 | SPI::SPI(const char * p_spidev, spi_config_t *p_spi_config){ 166 | m_spidev = NULL; 167 | if (p_spidev != NULL ){ 168 | m_spidev = (char *)malloc(strlen(p_spidev)+1); 169 | if (m_spidev != NULL) 170 | strcpy(m_spidev,p_spidev); 171 | } 172 | if (p_spi_config != NULL){ 173 | memcpy(&m_spiconfig,p_spi_config,sizeof(spi_config_t)); 174 | } 175 | else { 176 | m_spiconfig.mode = 0; 177 | m_spiconfig.speed = 1000000; 178 | m_spiconfig.bits_per_word = 8; 179 | m_spiconfig.delay = 0; 180 | 181 | } 182 | m_open = false; 183 | } 184 | 185 | SPI::~SPI(){ 186 | if (m_spidev != NULL ) { 187 | free(m_spidev); 188 | m_spidev = NULL; 189 | } 190 | if (m_open) 191 | close(m_spifd); 192 | } 193 | 194 | 195 | bool SPI::setConfig(spi_config_t *p_spi_config){ 196 | if (p_spi_config != NULL){ 197 | memcpy(&m_spiconfig,p_spi_config,sizeof(spi_config_t)); 198 | if (m_open){ 199 | /* Set SPI_POL and SPI_PHA */ 200 | if (ioctl(m_spifd, SPI_IOC_WR_MODE, &m_spiconfig.mode) < 0) { 201 | close(m_spifd); 202 | return false; 203 | } 204 | if (ioctl(m_spifd, SPI_IOC_RD_MODE, &m_spiconfig.mode) < 0) { 205 | close(m_spifd); 206 | return false; 207 | } 208 | 209 | /* Set bits per word*/ 210 | if (ioctl(m_spifd, SPI_IOC_WR_BITS_PER_WORD, &m_spiconfig.bits_per_word) < 0) { 211 | close(m_spifd); 212 | return false; 213 | } 214 | if (ioctl(m_spifd, SPI_IOC_RD_BITS_PER_WORD, &m_spiconfig.bits_per_word) < 0) { 215 | close(m_spifd); 216 | return false; 217 | } 218 | 219 | /* Set SPI speed*/ 220 | if (ioctl(m_spifd, SPI_IOC_WR_MAX_SPEED_HZ, &m_spiconfig.speed) < 0) { 221 | close(m_spifd); 222 | return false; 223 | } 224 | if (ioctl(m_spifd, SPI_IOC_RD_MAX_SPEED_HZ, &m_spiconfig.speed) < 0) { 225 | close(m_spifd); 226 | return false; 227 | } 228 | return true; 229 | } 230 | } 231 | return false; 232 | 233 | } 234 | 235 | 236 | 237 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | 341 | --------------------------------------------------------------------------------