├── gpio.txt ├── Makefile ├── README.md ├── main.c └── LICENSE /gpio.txt: -------------------------------------------------------------------------------- 1 | # sample GPIO key definitions for the PiPlay portable buttons 2 | #up 3 | pin_37 103 4 | #down 5 | pin_33 108 6 | #left 7 | pin_32 105 8 | #right 9 | pin_31 106 10 | #start = ENTER key 11 | pin_7 28 12 | #select = B 13 | pin_11 48 14 | #button a = Q 15 | pin_36 16 16 | #button b = W 17 | pin_38 17 18 | #button c = E 19 | pin_29 18 20 | #button d = Z 21 | pin_40 44 22 | 23 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | PROCESSOR:=$(shell grep -o "BCM.*" /proc/cpuinfo) 2 | ifeq ($(PROCESSOR), BCM2708) 3 | # Must be Raspberry Pi Zero 4 | $(info Building for Raspberry Pi Zero) 5 | CFLAGS=-c -I/opt/vc/include -Wall -O3 -D_RPIZERO_ 6 | LIBS= -lspi_lcd -lpigpio -L/opt/vc/lib -lbcm_host -lpthread -lm 7 | else ifeq ($(PROCESSOR), BCM2835) 8 | # Must be Raspberry Pi ZeroW 9 | $(info Building for Raspberry Pi ZeroW) 10 | CFLAGS=-c -I/opt/vc/include -Wall -O3 -D_RPIZERO_ 11 | LIBS= -lspi_lcd -lpigpio -L/opt/vc/lib -lbcm_host -lpthread -lm 12 | else ifeq ($(PROCESSOR), BCM2837) 13 | $(info Building for Raspberry Pi 3) 14 | CFLAGS=-c -I/opt/vc/include -Wall -O3 -D_RPI3_ 15 | LIBS= -lspi_lcd -lpigpio -L/opt/vc/lib -lbcm_host -lpthread -lm 16 | else 17 | # All other boards 18 | $(info Building for non-RPI board) 19 | CFLAGS=-c -Wall -O3 20 | LIBS= -lspi_lcd -lpthread -lm 21 | endif 22 | 23 | all: bbcp 24 | 25 | bbcp: Makefile main.o 26 | $(CC) main.o $(LIBS) -o bbcp 27 | 28 | main.o: main.c 29 | $(CC) $(CFLAGS) main.c 30 | 31 | clean: 32 | rm *.o bbcp 33 | 34 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | BB-CP - A replacement for FBTFT + FBCP 2 | 3 | The purpose of BB-CP is to provide an efficient means of mirroring the display 4 | of an ARM SBC onto an ili9341 LCD. For many gaming projects based on the 5 | Raspberry Pi and other ARM boards, the ili9341 320x240 LCD screens provide 6 | an inexpensive and flexible display. The only limitation of these displays is 7 | that by using a serial connection (SPI), the framerate is limited. In most 8 | cases, the maximum framerate (every pixel rewritten) that can be attained is 9 | 30-33 frames per second. This is a reasonable framerate, but for gamers, 10 | getting as close to 60 fps would be ideal. Since the game emulators were 11 | written to draw each frame on the framebuffer, they either need to be changed 12 | or a middle layer needs to be added to copy the contents to the LCD. The fbtft 13 | and fbcp projects are that middle layer. FBTFT is a kernel driver which creates 14 | a virtual framebuffer (/dev/fb1). Any drawing to that memory is detected by 15 | page faults (4k memory pages) and sent to the LCD in a timed loop. The second 16 | part of this scheme is FBCP. This is a user-level program which copies the 17 | image data from /dev/fb0 and scales it down to the size of /dev/fb1, then 18 | copies it to that framebuffer. On Raspberry Pi boards, there is GPU assistance 19 | to do the scaling/copying from an API called dispmanx. The flaw in this scheme 20 | is that FBTFT and FBCP have no knowledge of each other nor when the game has 21 | drawn a new screen. They handle this by both running in a loop with a sleep() 22 | to try to run at a reasonable rate. This introduces latency for each. 23 | 24 | BB-CP solves some of these issues by doing the job of both FBTFT and FBCP. 25 | The BB-CP code also improves the framerate by comparing the current frame to 26 | the previous and only sending the changed "tiles" to the display. For games 27 | which don't have complex/scrolling backgrounds, this can improve the framerate. 28 | 29 | Requirements: 30 | 1) An ARM SBC (Raspberry Pi, Orange Pi, NanoPi) 31 | 2) My SPI_LCD library (https://github.com/bitbank2/SPI_LCD) 32 | 3) PIGPIO library (if using RPI hardware - https://github.com/joan2937/pigpio) 33 | 34 | How to build 35 | ------------ 36 | clone the SPI_LCD project 37 | edit spi_lcd.c to use the SPI/GPIO access method appropriate for your board 38 | make SPI_LCD (cd SPI_LCD & make) 39 | make BB-CP (cd BB-CP & make) 40 | 41 | How to run 42 | ---------- 43 | sudo ./bbcp 44 | 45 | Press ENTER to quit bbcp. This is necessary because if you kill it by pressing 46 | ctrl-c, some SPI libraries (e.g. PIGPIO) won't shutdown and to run it again 47 | will require a reboot.
48 |
49 | 50 | If you find this code useful, please consider buying me a cup of coffee
51 | [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SR4F44J2UR8S4) 52 | -------------------------------------------------------------------------------- /main.c: -------------------------------------------------------------------------------- 1 | // 2 | // BB-CP - a faster replacement for FBTFT + FBCP 3 | // 4 | // Copyright (c) 2017 Larry Bank 5 | // email: bitbank@pobox.com 6 | // Project started 11/22/2017 7 | // 8 | // This program 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 3 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, see . 20 | // 21 | // 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include 36 | 37 | // Use dispmanx API on RPi0 38 | #if defined( _RPIZERO_ ) || defined (_RPI3_) 39 | #include 40 | DISPMANX_DISPLAY_HANDLE_T display; 41 | DISPMANX_RESOURCE_HANDLE_T screen_resource; 42 | DISPMANX_MODEINFO_T display_info; 43 | VC_IMAGE_TRANSFORM_T transform; 44 | uint32_t image_prt; 45 | VC_RECT_T rect1; 46 | #endif // _RPIZERO_ 47 | 48 | // We only support the ILI9341 (240x320), but define these just in case 49 | #define LCD_CX 320 50 | #define LCD_CY 240 51 | 52 | // Maximum supported GPIO pins 53 | #define MAX_GPIO 43 54 | 55 | // Pointers to the local copies of the framebuffer 56 | static unsigned char *pScreen, *pAltScreen; 57 | #if !defined( _RPIZERO_ ) && !defined( _RPI3_ ) 58 | static unsigned char *pFB; // pointer to /dev/fb0 59 | static int iFBPitch; // bytes per line of /dev/fb0 60 | static int iScreenSize; 61 | // Framebuffer variable and fixed info 62 | static struct fb_var_screeninfo vinfo; 63 | static struct fb_fix_screeninfo finfo; 64 | #endif // !_RPIZERO_ 65 | static int iLCDPitch; // bytes per line of our LCD buffer 66 | static int fbfd; // framebuffer file handle 67 | static int iTileWidth, iTileHeight; 68 | static int bRunning, bShowFPS, bLCDFlip, iSPIChan, iSPIFreq, iDC, iReset, iLED; 69 | static char szKeyConfig[256]; // text file defining GPIO keyboard mapping 70 | static int iKeyDefs; // number of GPIO keys defined 71 | static int iGPIOList[MAX_GPIO], iKeyList[MAX_GPIO], iKeyState[MAX_GPIO]; 72 | static int fdui; // file handle for uinput 73 | static int bBackground; // indicates if our process is running in the bkgd 74 | void shutdown(void); 75 | // 76 | // Get the current time in nanoseconds 77 | // 78 | static uint64_t NanoClock() 79 | { 80 | uint64_t ns; 81 | struct timespec time; 82 | 83 | clock_gettime(CLOCK_MONOTONIC, &time); 84 | ns = time.tv_nsec + (time.tv_sec * 1000000000LL); 85 | return ns; 86 | } /* NanoClock() */ 87 | void SkipToEnd(char *pBuf, int *i, int iLen) 88 | { 89 | int j = *i; 90 | while (j < iLen) 91 | { 92 | if (pBuf[j] == 0xa || pBuf[j] == 0xd) // end of the line 93 | break; 94 | j++; 95 | } 96 | while (j < iLen && (pBuf[j] == 0xa || pBuf[j] == 0xd)) 97 | { 98 | j++; 99 | } 100 | *i = j; 101 | } /* SkipToEnd() */ 102 | 103 | int ParseNumber(char *pBuf, int *i, int iLen) 104 | { 105 | char cTemp[32]; 106 | int iValue; 107 | int k = 0; 108 | int j = *i; 109 | 110 | // skip spaces and non numbers 111 | while (j < iLen && (pBuf[j] < '0' || pBuf[j] > '9')) 112 | { 113 | j++; 114 | } 115 | if (j >= iLen) // went past end, problem 116 | return 0; 117 | while (j < iLen && k < 32 && (pBuf[j] >= '0' && pBuf[j] <= '9')) 118 | { 119 | cTemp[k++] = pBuf[j++]; 120 | } 121 | cTemp[k] = '\0'; // terminate string 122 | iValue = atoi(cTemp); 123 | *i = j; 124 | return iValue; 125 | } /* ParseNumber() */ 126 | 127 | // 128 | // Parse config file which defines GPIO keyboard mapping 129 | // 130 | int ParseConfig(char *szConfig) 131 | { 132 | char *pBuf; 133 | int i, j, k, iLen; 134 | FILE *pf; 135 | struct uinput_user_dev uidev; 136 | 137 | iKeyDefs = 0; // no keys defined 138 | pf = fopen(szConfig, "rb"); 139 | if (pf == NULL) 140 | { 141 | fprintf(stderr, "Error opening file %s\n", szConfig); 142 | return 1; 143 | } 144 | fseek(pf, 0, SEEK_END); 145 | iLen = (int)ftell(pf); // get the file size 146 | fseek(pf, 0, SEEK_SET); 147 | pBuf = malloc(iLen); // buffer to read text file 148 | i = fread(pBuf, 1, iLen, pf); 149 | fclose(pf); 150 | 151 | // parse the file 152 | i = 0; 153 | while (i < iLen) 154 | { 155 | if (pBuf[i] == '#') // comment, skip line 156 | SkipToEnd(pBuf, &i, iLen); 157 | else if (memcmp(&pBuf[i], "pin_", 4) == 0) 158 | { 159 | i+=4; 160 | j = ParseNumber(pBuf, &i, iLen); // capture GPIO pin number 161 | k = ParseNumber(pBuf, &i, iLen); // capture keyboard code 162 | if (j <= MAX_GPIO && k >= 1 && k < 255) // valid? 163 | { 164 | iGPIOList[iKeyDefs] = j; 165 | iKeyList[iKeyDefs] = k; 166 | iKeyState[iKeyDefs] = 1; // set to on (not pressed) 167 | iKeyDefs++; 168 | } 169 | } 170 | else 171 | { 172 | i++; 173 | } 174 | } // while parsing... 175 | free(pBuf); 176 | // Set up the keypress simulator device 177 | fdui = open("/dev/uinput", O_WRONLY | O_NONBLOCK); 178 | if (fdui < 0) 179 | { 180 | fprintf(stderr, "Error opening /dev/uinput device\n"); 181 | return 1; 182 | } 183 | ioctl(fdui, UI_SET_EVBIT, EV_KEY); 184 | for (i=0; i 999999999LL) return; 217 | ts.tv_sec = 0; 218 | ts.tv_nsec = ns; 219 | nanosleep(&ts, NULL); 220 | } /* NanoSleep() */ 221 | 222 | // 223 | // Initialize the framebuffer and SPI LCD 224 | // 225 | // Return 0 for success, 1 for failure 226 | // 227 | static int InitDisplay(int bLCDFlip, int iSPIChan, int iSPIFreq, int iDC, int iReset, int iLED) 228 | { 229 | 230 | #if defined( _RPIZERO_ ) || defined( _RPI3_ ) 231 | { 232 | int ret; 233 | bcm_host_init(); 234 | display = vc_dispmanx_display_open(0); 235 | if (!display) 236 | { 237 | fprintf(stderr, "Unable to open primary display\n"); 238 | return 1; 239 | } 240 | ret = vc_dispmanx_display_get_info(display, &display_info); 241 | if (ret) 242 | { 243 | fprintf(stderr, "Unable to get primary display information\n"); 244 | return 1; 245 | } 246 | screen_resource = vc_dispmanx_resource_create(VC_IMAGE_RGB565, LCD_CX, LCD_CY, &image_prt); 247 | if (!screen_resource) 248 | { 249 | fprintf(stderr, "Unable to create screen buffer\n"); 250 | close(fbfd); 251 | vc_dispmanx_display_close(display); 252 | return 1; 253 | } 254 | vc_dispmanx_rect_set(&rect1, 0, 0, LCD_CX, LCD_CY); 255 | } 256 | #else 257 | // Open and map a pointer to the fb0 framebuffer 258 | fbfd = open("/dev/fb0", O_RDWR); 259 | if (fbfd) 260 | { 261 | // get the fixed screen info 262 | ioctl(fbfd, FBIOGET_FSCREENINFO, &finfo); 263 | // get the variable screen info 264 | ioctl(fbfd, FBIOGET_VSCREENINFO, &vinfo); 265 | iFBPitch = (vinfo.xres * vinfo.bits_per_pixel) / 8; 266 | iScreenSize = finfo.smem_len; 267 | pFB = (unsigned char *)mmap(0, iScreenSize, PROT_READ | PROT_WRITE, MAP_SHARED, fbfd, 0); 268 | } 269 | else // can't open display 270 | { 271 | return 1; 272 | } 273 | #endif // _RPIZERO_ 274 | 275 | if (spilcdInit(LCD_ILI9341, bLCDFlip, iSPIChan, iSPIFreq, iDC, iReset, iLED)) 276 | return 1; 277 | spilcdSetOrientation(LCD_ORIENTATION_ROTATED); // we want landscape mode on the ili9341; an ili9342 wouldn't require this 278 | 279 | // Allocate 2 local copies of the framebuffer for comparison 280 | iLCDPitch = LCD_CX * 2; 281 | pScreen = malloc(iLCDPitch * LCD_CY); 282 | pAltScreen = malloc(iLCDPitch * LCD_CY); // our copy of the display 283 | 284 | return 0; 285 | } /* InitDisplay() */ 286 | 287 | // 288 | // Compare the current frame with the previous and mark changed tiles 289 | // as a set bit in an array of flags 290 | // 291 | static int FindChangedRegion(unsigned char *pSrc, unsigned char *pDst, int iWidth, 292 | int iHeight, int iPitch, int iTileWidth, int iTileHeight, uint32_t *pRegions) 293 | { 294 | int x, y, xc, yc, dy; 295 | int xCount, yCount; 296 | uint32_t *s, *d, u32RowBits; 297 | int iTotalChanged = 0; 298 | // 299 | // Divide the image into 16x16 tiles; each tile on a row is 1 bit in the changed bit field 300 | // This makes managing the changes easier for display on a normal monitor and on LCDs with 301 | // slow connections (e.g. SPI/I2C) 302 | // The code has an "early exit" for each tile. In essence, the more the bitmaps are alike 303 | // the harder this code will work and the less of the screen will need to be repainted 304 | // In other words, the performance is balanced such that it should maintain a constant output rate 305 | // no matter what the bitmap conditions are 306 | // 307 | yCount = (iHeight+iTileHeight-1) / iTileHeight; // divide it into NxN tiles 308 | xCount = (iWidth+iTileWidth-1) / iTileWidth; 309 | 310 | // Loop through all of the tiles 311 | for (yc=0; yc iHeight) 321 | dy = iHeight - (yc*iTileHeight); 322 | else 323 | dy = iTileHeight; 324 | for (y =0/* iPatOff */; y= LCD_CX * 2) // need to shrink by 1/4 355 | { 356 | if (vinfo.bits_per_pixel == 16) 357 | { 358 | uint32_t *s, *d, u32Magic, u32_1, u32_2; 359 | int x, y; 360 | u32Magic = 0xf7def7de; 361 | for (y=0; y> 1; 371 | u32_2 = (u32_2 & u32Magic) >> 1; 372 | u32_1 += (u32_1 << 16); 373 | u32_2 += (u32_2 >> 16); // average 374 | u32_1 = (u32_1 >> 16) | (u32_2 << 16); 375 | *d++ = u32_1; 376 | s += 2; 377 | } // for x 378 | } // for y 379 | } 380 | else // need to convert to RGB565 381 | { 382 | uint32_t u32, *pSrc; 383 | int x, y; 384 | uint16_t u16, *pDest; 385 | 386 | for (y=0; y> 3) & 0x1f) | ((u32 >> 5) & 0x7e0) | 394 | ((u32 >> 8) & 0xf800); 395 | *pDest++ = u16; 396 | } 397 | } 398 | } 399 | } 400 | else // 1:1 401 | { 402 | if (vinfo.bits_per_pixel == 16) 403 | { 404 | memcpy(pScreen, pFB, iFBPitch * vinfo.yres); 405 | } 406 | else // need to convert the pixels 407 | { 408 | uint32_t u32, *pSrc; 409 | int x, y; 410 | uint16_t u16, *pDest; 411 | 412 | for (y=0; y> 3) & 0x1f) | ((u32 >> 5) & 0x7e0) | 420 | ((u32 >> 8) & 0xf800); 421 | *pDest++ = u16; 422 | } 423 | } 424 | } 425 | } 426 | #endif // _RPIZERO_ 427 | } /* FBCapture() */ 428 | 429 | // 430 | // Turn GPIO button presses into keyboard events 431 | // This would be more efficient to do as interrupt driven events 432 | // but reading the keys every frame takes an insignificant amount 433 | // of time. This allows for simpler GPIO access which will work 434 | // on more platforms. 435 | // 436 | void ProcessKeys(void) 437 | { 438 | int i, rc, iState; 439 | struct input_event ie; 440 | 441 | memset(&ie, 0, sizeof(ie)); 442 | 443 | // Loop through all of the defined keys 444 | for (i=0; i LCD_CY) j = LCD_CY - i; 494 | memcpy(&pAltScreen[i*iLCDPitch], (void *)&pScreen[i*iLCDPitch], j * iLCDPitch); // copy regions which changed 495 | } 496 | } 497 | // Draw the changed tiles 498 | pRegions = u32Regions; 499 | iCount = 0; // number we've drawn 500 | for (y=0; y>= 1; // shift down to next bit flag 513 | } 514 | } 515 | 516 | } 517 | } /* CopyLoop() */ 518 | 519 | // 520 | // Parse the command line options 521 | // 522 | static int ParseOpts(int argc, char *argv[]) 523 | { 524 | int i = 1; 525 | 526 | while (i < argc) 527 | { 528 | /* if it isn't a cmdline option, we're done */ 529 | if (0 != strncmp("--", argv[i], 2)) 530 | break; 531 | /* GNU-style separator to support files with -- prefix 532 | * example for a file named "--baz": ./foo --bar -- --baz 533 | */ 534 | if (0 == strcmp("--", argv[i])) 535 | { 536 | i += 1; 537 | break; 538 | } 539 | /* test for each specific flag */ 540 | if (0 == strcmp("--spi_bus", argv[i])) { 541 | iSPIChan = atoi(argv[i+1]); 542 | i += 2; 543 | } else if (0 == strcmp("--background", argv[i])) { 544 | bBackground = 1; 545 | i++; 546 | } else if (0 == strcmp("--spi_freq", argv[i])) { 547 | iSPIFreq = atoi(argv[i+1]); 548 | i += 2; 549 | } else if (0 == strcmp("--flip", argv[i])) { 550 | i++; 551 | bLCDFlip = 1; 552 | } else if (0 == strcmp("--lcd_dc", argv[i])) { 553 | iDC = atoi(argv[i+1]); 554 | i += 2; 555 | } else if (0 == strcmp("--lcd_rst", argv[i])) { 556 | iReset = atoi(argv[i+1]); 557 | i += 2; 558 | } else if (0 == strcmp("--lcd_led", argv[i])) { 559 | iLED = atoi(argv[i+1]); 560 | i += 2; 561 | } else if (0 == strcmp("--gpiokeys", argv[i])) { 562 | strcpy(szKeyConfig, argv[i+1]); 563 | i += 2; 564 | } else if (0 == strcmp("--showfps",argv[i])) { 565 | bShowFPS = 1; 566 | i++; 567 | } else { 568 | fprintf(stderr, "Unknown parameter '%s'\n", argv[i]); 569 | exit(1); 570 | } 571 | } 572 | return i; 573 | 574 | } /* ParseOpts() */ 575 | 576 | static void ShowHelp(void) 577 | { 578 | printf( 579 | "BB-CP: copy framebuffer to SPI LCD\n" 580 | "Copyright (c) 2017 BitBank Software, Inc.\n" 581 | "Written by Larry Bank\n\n" 582 | "Options:\n" 583 | " --spi_bus defaults to 0\n" 584 | " --spi_freq defaults to 31250000\n" 585 | " --lcd_dc defaults to 18\n" 586 | " --lcd_rst defaults to 22\n" 587 | " --lcd_led defaults to 13\n" 588 | " --gpiokeys \n" 589 | " --flip flips display 180 degrees\n" 590 | " --showfps Show framerate\n" 591 | " --background suppress printf output if running as a bkgd process\n" 592 | "\nExample usage:\n" 593 | "sudo ./bbcp --spi_bus 1 spi_freq 46000000 --flip\n" 594 | ); 595 | } /* ShowHelp() */ 596 | 597 | void *CopyThread(void *pArg) 598 | { 599 | int64_t ns; 600 | uint64_t llTime, llFrameDelta, llTargetTime, llOldTime; 601 | float fps; 602 | int iVideoFrames = 0; 603 | 604 | llFrameDelta = 1000000000 / 60; // time slice in nanoseconds (60 FPS) 605 | llTargetTime = llOldTime = NanoClock() + llFrameDelta; // end of frame time 606 | 607 | while (bRunning) 608 | { 609 | CopyLoop(); // send the display to the LCD 610 | iVideoFrames++; 611 | llTime = NanoClock(); // get clock time in nanoseconds 612 | ns = llTargetTime - llTime; 613 | if (bShowFPS && (llTime - llOldTime) > 1000000000LL) // update every second 614 | { 615 | fps = (float)iVideoFrames; 616 | fps = fps * 1000000000.0; 617 | fps = fps / (float)(llTime-llOldTime); 618 | if (!bBackground) 619 | printf("%02.1f FPS\n", fps); 620 | iVideoFrames = 0; 621 | llOldTime = llTime; 622 | } 623 | if (ns < 0) // we fell behind 624 | { 625 | while (ns < 0) 626 | { 627 | ns += llFrameDelta; 628 | llTargetTime += llFrameDelta; 629 | } 630 | // sleep at least a little to yield the thread. On a single CPU core 631 | // this is necessary to not starve the game emulator thread 632 | 633 | NanoSleep(4000LL); 634 | } 635 | else // just sleep to fill the rest of the 1/60th second 636 | { 637 | NanoSleep(ns); 638 | } 639 | llTargetTime += llFrameDelta; 640 | } // while running 641 | return NULL; 642 | } /* CopyThread() */ 643 | 644 | // 645 | // Catch CTRL-C here 646 | // 647 | void signal_handler(int signum) 648 | { 649 | printf("Ctrl-C hit; exiting...\n"); 650 | shutdown(); 651 | exit(0); // quit the program quietly 652 | } /* signal_handler() */ 653 | 654 | void shutdown(void) 655 | { 656 | // Quit library and free resources 657 | bRunning = 0; // tell background thread to stop 658 | NanoSleep(50000000LL); // wait 50ms for work to finish 659 | spilcdShutdown(); 660 | // shut down the keypress simulator device 661 | if (fdui >= 0) 662 | { 663 | ioctl(fdui, UI_DEV_DESTROY); 664 | close(fdui); 665 | } 666 | #if defined( _RPIZERO_ ) || defined( _RPI3_ ) 667 | vc_dispmanx_resource_delete(screen_resource); 668 | vc_dispmanx_display_close(display); 669 | #endif // _RPIZERO_ 670 | } /* shutdown() */ 671 | 672 | int main(int argc, char* argv[]) 673 | { 674 | int i; 675 | pthread_t tinfo; 676 | 677 | if (argc < 2) 678 | { 679 | ShowHelp(); 680 | return 0; 681 | } 682 | 683 | // Set default values 684 | bShowFPS = 0; 685 | iSPIChan = 0; // 0 for RPI, usually 1 for Orange Pi 686 | iSPIFreq = 31250000; // good for RPI, use higher for AllWinner 687 | bLCDFlip = 0; 688 | strcpy(szKeyConfig, ""); // assume no GPIO keyboard mapping 689 | iKeyDefs = 0; // assume no GPIO keys 690 | fdui = -1; 691 | bBackground = 0; // assume we're not a background process 692 | // These are the header pin numbers of the ILI9341 control lines 693 | // 18 means pin 18 on the 40 pin IO header 694 | iDC = 18; iReset = 22; iLED = 13; 695 | 696 | iTileWidth = 64; // for now - different values might be more efficient 697 | iTileHeight = 30; 698 | 699 | ParseOpts(argc, argv); // gather the command line parameters 700 | 701 | if (strlen(szKeyConfig)) // if config file specified, parse it 702 | { 703 | if (ParseConfig(szKeyConfig)) 704 | { 705 | fprintf(stderr, "Error configuring GPIO keys; re-check pin numbers for conflicts\n"); 706 | return 0; 707 | } 708 | } 709 | 710 | // Initialize the SPI_LCD library and get a pointer to /dev/fb0 711 | if (InitDisplay(bLCDFlip, iSPIChan, iSPIFreq, iDC, iReset, iLED)) 712 | { 713 | fprintf(stderr, "Error initializing the LCD/display\n"); 714 | return 0; 715 | } 716 | 717 | // Initialize the header pins specified to be GPIO inputs 718 | // This needs to be done after initializing the LCD since 719 | // SPI_LCD initializes the gpio functions in the LCD init 720 | for (i=0; i 640) 730 | printf("Warning: the framebuffer is too large and will not be copied properly; sipported sizes are 640x480 and 320x240\n"); 731 | if (vinfo.bits_per_pixel == 32) 732 | printf("Warning: the framebuffer bit depth is 32-bpp, ideally it should be 16-bpp for fastest results\n"); 733 | #endif // !_RPIZERO_ 734 | 735 | signal(SIGINT, signal_handler); // catch CTRL-C 736 | 737 | // Do a quick performance test to make sure everything is working correctly 738 | { 739 | uint64_t llTime; 740 | int iFrames = 0; 741 | llTime = NanoClock() + 1000000000LL; 742 | while (NanoClock() < llTime) // run for 1 second 743 | { // force total redraw each frame 744 | memset(pAltScreen, 0xff, iLCDPitch * LCD_CY); 745 | CopyLoop(); 746 | iFrames++; 747 | } 748 | if (!bBackground) 749 | { 750 | printf("Perf test: worst case framerate = %d FPS\n", iFrames); 751 | if (iFrames < 25) 752 | printf("<25FPS indicates there is something not configured correctly with your SW/HW\n"); 753 | } 754 | } 755 | 756 | // Start screen copy thread 757 | bRunning = 1; 758 | pthread_create(&tinfo, NULL, CopyThread, NULL); 759 | if (!bBackground) 760 | { 761 | printf("Press ENTER to quit\n"); 762 | getchar(); // wait for user to press enter 763 | } 764 | else // run forever 765 | { 766 | while (1) {}; 767 | } 768 | 769 | shutdown(); 770 | 771 | return 0; 772 | } /* main() */ 773 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------