From 05509f8513531a7514c7cf3aa13da3f56f6b5ee7 Mon Sep 17 00:00:00 2001 From: RISCi_ATOM Date: Sat, 2 Dec 2017 18:25:25 -0500 Subject: [PATCH] Move wiki docs to /docs --- .gitignore | 1 - README.md | 15 + docs/Ben_Nanonote.md | 263 ++++++++++++ docs/How To Submit A Change To This Wiki.md | 55 +++ docs/How_To_Build_libreCMC.md | 73 ++++ docs/LICENSE.md | 430 ++++++++++++++++++++ docs/List_of_Tested_Hardware.md | 22 + docs/Router_Reset_Instructions.md | 53 +++ docs/Supported_Hardware.md | 37 ++ docs/TL_MR3020.md | 42 ++ docs/TL_WR1043ND.md | 28 ++ docs/TL_WR741ND.md | 15 + docs/TL_WR841ND.md | 25 ++ docs/TL_WR842ND.md | 41 ++ docs/TPE_NWIFIROUTER2.md | 20 + docs/TPE_R1100.md | 25 ++ docs/WNDR3800.md | 11 + docs/WZR_HP_G300NH.md | 13 + docs/Welcome.md | 71 ++++ docs/embedded.md | 15 + docs/old/Save_WiFi.md | 24 ++ docs/testing.md | 3 + 22 files changed, 1281 insertions(+), 1 deletion(-) create mode 100644 README.md create mode 100644 docs/Ben_Nanonote.md create mode 100644 docs/How To Submit A Change To This Wiki.md create mode 100644 docs/How_To_Build_libreCMC.md create mode 100644 docs/LICENSE.md create mode 100644 docs/List_of_Tested_Hardware.md create mode 100644 docs/Router_Reset_Instructions.md create mode 100644 docs/Supported_Hardware.md create mode 100644 docs/TL_MR3020.md create mode 100644 docs/TL_WR1043ND.md create mode 100644 docs/TL_WR741ND.md create mode 100644 docs/TL_WR841ND.md create mode 100644 docs/TL_WR842ND.md create mode 100644 docs/TPE_NWIFIROUTER2.md create mode 100644 docs/TPE_R1100.md create mode 100644 docs/WNDR3800.md create mode 100644 docs/WZR_HP_G300NH.md create mode 100644 docs/Welcome.md create mode 100644 docs/embedded.md create mode 100644 docs/old/Save_WiFi.md create mode 100644 docs/testing.md diff --git a/.gitignore b/.gitignore index 9455cb5236..0e717acfa1 100644 --- a/.gitignore +++ b/.gitignore @@ -29,5 +29,4 @@ git-src *.so *.swp *.po~ -/docs /package/luci/modules/luci-base/src/po2lmo diff --git a/README.md b/README.md new file mode 100644 index 0000000000..65f475b819 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# libreCMC : The _libre_ Embedded GNU/Linux Distro. + +libreCMC is a set of fully [free](http://www.gnu.org/philosophy/free-sw.en.html) embedded Operating Systems for general purpose computers. It aims to give its users freedom and control over the software that runs on their hardware. Most of the hardware that libreCMC supports includes a wide range of routers and some small single board computers. + +## Useful links: + +* [Get libreCMC source code](/) : Checkout the latest libreCMC sources. + +* [Supported Hardware](/docs/Supported_Hardware.md): Devices officially supported by libreCMC. + +* [Router reset instructions](/docs/Router_Reset_Instructions.md) : Generic libreCMC router reset instructions. + +* [Report a bug or issue](/issues) : Is something broken? Did you find a non-free component or do you want to make libreCMC better? Submit an issue. + +* [Build Documentation](/docs/How_To_Build_libreCMC.md) : Learn how to build libreCMC for your device. diff --git a/docs/Ben_Nanonote.md b/docs/Ben_Nanonote.md new file mode 100644 index 0000000000..60971687d1 --- /dev/null +++ b/docs/Ben_Nanonote.md @@ -0,0 +1,263 @@ + +== Overview == + +* [http://en.ingenic.cn/product.aspx?ID=60 JZ4720] 336 MHz MIPS compatible processor from [http://www.ingenic.cn Ingenic Semiconductor Co.] + +* 3.0" 320x240 pixels [[LCD|colour TFT LCD]] (40x15 character in a text console) + +* 32MB [[SDRAM]] + +* 2GB [[NAND|NAND Flash]] Memory + +* 1 [[SD|microSDHC]] slot (SDIO capable) + +* 59 keys Keyboard + +* Stereo headphones connector, mono speaker and microphone [[Audio_IN_OUT|audio interfaces]]. + +* [http://wiki.qi-hardware.com/wiki/USB_host USB] 2.0 High-Speed Device, [http://en.wikipedia.org/wiki/USB#Connector_types Mini B] connector + +* 3.7V 850mAh Li-ion Battery ( [[Compatible_batteries|Compatible batteries]]) and 5V 500mA [[Power_Supply_Circuit|DC input through USB port]] + +* Measured battery life time, idle, screen off: 12h59 + +* Overall dimension (lid closed): 99 * 75 * 17.5mm. (display: 7.5mm, keyboard: 10mm) + +* Weight: 126g (includes battery) + +== Status == + +* Flashing bootloader, kernel, and rootfs via USB works. +* Serial console via GND/RXD/TXD pads under the battery works. +* LCD works +** After a few minutes of inactivity on the console, it will go blank. Pressing any key brings it back. +* Keyboard works +* Audio/ALSA works. +* ... + +== Pinouts == + +PCB 08.50 (ben) + +'''Micro-SD pins on testpads:''' + + Pin TP note + ------------------ + #1 TP14 data2 + #2 TP15 cd/data3 / _CS + #3 TP17 cmd / mosi + #4 sdVCC switched by Q4 (fet?) controlled via line from cpu (on TP11) + #5 TP16 clock + #6 GND + #7 TP12 data0 / miso + #8 TP13 data1 + +'''Serial pins:''' + +See [[Ben_source_code#serial_console]]. + +== System information == + + $ '''cat /proc/cpuinfo''' + system type : JZ4740 + processor : 0 + cpu model : Ingenic JZRISC V4.15 + BogoMIPS : 335.05 + wait instruction : yes + microsecond timers : no + tlb_entries : 32 + extra interrupt vector : yes + hardware watchpoint : yes, count: 1, address/irw mask: [0x0fff] + ASEs implemented : + shadow register sets : 1 + core : 0 + VCED exceptions : not available + VCEI exceptions : not available + + $ '''cat /proc/mtd''' + dev: size erasesize name + mtd0: 00400000 00080000 "NAND BOOT partition" + mtd1: 00400000 00080000 "NAND KERNEL partition" + mtd2: 20000000 00080000 "NAND ROOTFS partition" + mtd3: 5f800000 00080000 "NAND DATA partition" + + $ '''uname -a''' + Linux BenNanoNote 2.6.32.27 #1 PREEMPT Sat Mar 5 03:54:50 MSK 2011 mips GNU/Linux + + $ '''cat /proc/iomem''' + 00000000-01ffffff : System RAM + 00010000-0031162b : Kernel code + 0031162c-0040877f : Kernel data + 10003000-10003037 : jz4740-rtc + 10003000-10003037 : jz4740-rtc + 10020000-10020037 : jz4740-i2s + 10020000-10020037 : jz4740-i2s + 10020080-10020087 : jz4740-codec + 10020080-10020087 : jz4740-codec + 10021000-10030fff : jz4740-mmc.0 + 10021000-10030fff : jz4740-mmc + 10070000-10070030 : jz4740-adc + 10070000-10070030 : jz4740-adc + 13010000-1301ffff : jz4740-nand.0 + 13010000-1301ffff : jz4740-nand + 13030000-1303ffff : jz-ohci.0 + 13040000-1304ffff : jz-udc + 13040000-1304ffff : jz-udc + 13050000-1305ffff : jz4740-fb + 13050000-1305ffff : jz4740-fb + + $ '''cat /proc/interrupts''' + CPU0 + 2: 33611 MIPS JZ4740 cascade interrupt + 17: 20 INTC serial + 20: 56 INTC jz4740-adc + 22: 47 INTC MMC/SD + 23: 0 INTC jz4740-rtc + 28: 0 INTC DMA + 31: 32374 INTC jz4740-timerirq + 32: 527 INTC jz-udc + 147: 0 GPIO Bank C jz4740-battery + 152: 0 GPIO Bank D MMC/SD detect changed + 170: 0 GPIO Bank D matrix-keypad + 171: 94 GPIO Bank D matrix-keypad + 172: 77 GPIO Bank D matrix-keypad + 173: 17 GPIO Bank D matrix-keypad + 174: 151 GPIO Bank D matrix-keypad + 175: 13 GPIO Bank D matrix-keypad + 176: 235 GPIO Bank D matrix-keypad + 178: 0 GPIO Bank D matrix-keypad + 180: 0 GPIO Bank D gpio-charger.0 + 181: 0 GPIO Bank D Power + ERR: 0 + +== GPIO pins == + +The Jz4720 has only a limited number of pins as outputs to the board. Furthermore, several functions take up gpio pins which are therefore not usable for other functions. Those devices are the sdram and nand controller, lcd controller and mmc+sd controller. Below is a table showing how they are used. Please complete this table. The missing entries are not connected to a pad in the Jz4720. + +'''Port A:''' +* 01 sdram data 0 +* 03 sdram data 1 +* 05 sdram data 2 +* 07 sdram data 3 +* 08 sdram data 4 +* 09 sdram data 5 +* 10 sdram data 6 +* 11 sdram data 7 +* 12 sdram data 8 +* 13 sdram data 9 +* 15 sdram data 10 +* 17 sdram data 11 +* 22 sdram data 12 +* 26 sdram data 13 +* 28 sdram data 14 +* 30 sdram data 15 + +'''Port B:''' +* 00 sdram address 0 +* 01 sdram address 1 +* 02 sdram address 2 +* 03 sdram address 3 +* 04 sdram address 4 +* 05 sdram address 5 +* 06 sdram address 6 +* 07 sdram address 7 +* 08 sdram address 8 +* 09 sdram address 9 +* 10 sdram address 10 +* 11 sdram address 11 +* 12 sdram address 12 +* 13 sdram address 13 +* 14 sdram address 14 +* 15 nand command latch +* 16 nand address latch +* 17 not connected (was marked "SHDN_HOST???", but schematic disagrees) +* 18 TP23 (free) +* 19 sdram dcs +* 20 sdram ras +* 21 sdram cas +* 22 sdram write enable +* 23 sdram cke +* 24 sdram cko +* 25 sdram cs1 +* 26 sdram cs2 +* 27 not connected (was marked "USB ID", but schematic disagrees) +* 28 not connected +* 29 Audio output enable (anti-pop control) +* 30 TP25 (free) +* 31 sdram write enable 0 + +'''Port C:''' +* 00 lcd data 0 +* 01 lcd data 1 +* 02 lcd data 2 +* 03 lcd data 3 +* 04 lcd data 4 +* 05 lcd data 5 +* 06 lcd data 6 +* 07 lcd data 7 +* 08 TP 35 (free) +* 09 TP 36 (free) +* 10 keyboard out 1, TP59 +* 11 keyboard out 2, TP60 +* 12 keyboard out 3, TP61 +* 13 keyboard out 4, TP62 +* 14 keyboard out 5, TP63 +* 15 keyboard out 6, TP64 +* 16 keyboard out 7, TP65 +* 17 keyboard out 8, TP66 +* 18 lcd pixel clock +* 19 lcd hsync +* 20 lcd vsync +* 21 lcd SPI chipselect +* 22 lcd SPI data +* 23 lcd SPI clock +* 24 sdram write enable 1 +* 27 Charge detect (analog input to read battery voltage). +* 28 nand read enable +* 29 nand write enable +* 30 nand flash ready/busy +* 31 not connected to a pad; PCSEL31 selects jtag (PCSEL31==0) or uart0 (PCSEL31==1) on pad 147(TxD)+148(RxD) (TP5+TP4). + +'''Port D:''' +* 00 SD Card detect +* 02 SD Card power enable +* 04 Speaker AMP enable (no audio unless this output is pulled low). +* 06 Low power indicator (if 0, battery power is low). +* 08 SD Card command +* 09 SD Card clock +* 10 SD Card data 1 +* 11 SD Card data 2 +* 12 SD Card data 3 +* 13 SD Card data 4 +* 15 TP 38 (free) +* 18 Keyboard in 1, TP67 +* 19 Keyboard in 2, TP68 +* 20 Keyboard in 3, TP69 +* 21 Keyboard in 4, TP70 +* 22 Keyboard in 5, TP71 +* 23 Keyboard in 6, TP72 +* 24 Keyboard in 7, TP73 +* 25 uart0 transmit, TP75 +* 26 Keyboard in 8 (uart0 receive), TP74 +* 27 Buzzer, controlled with pwm4. Piezo-electric buzzer; not related to soundcard output. +* 28 USB detect (0 if usb power is present). +* 29 power button (0 if pressed). + +=== Sorted by function === +* buzzer: D27 +* audio: B29, D4 +* power button: D29 +* keyboard: C10, C11, C12, C13, C14, C15, C16, C17, D18, D19, D20, D21, D22, D23, D24, D26(also uart receive) +* uart: C31, D25, D26(also keyboard), uart is also available on jtag pads TP4+TP5 (without gpio overload). +* sd/mmc: D0, D2, D8, D9, D10, D11, D12, D13 +* usb: D28 +* battery: C27, D6 +* sdram: A1, A3, A5, A7, A8, A9, A10, A11, A12, A13, A15, A17, A22, A26, A28, A30, B0, B1, B2, B3, B4, B5, B6, B7, B8, B9, B10, B11, B12, B13, B14, B19, B10, B21, B22, B23, B24, B25, B26, B31, C24 +* nand: B15, B16, C28, C29, C30 +* lcd: C0, C1, C2, C3, C4, C5, C6, C7, C18, C19, C20, C21, C22, C23 +* only test points: B18, B30, C8, C9, D15 +* unconnected pads: B17, B27, B28 + +[[Category:Ben NanoNote]] + +This content is dual licensed under CC-BY-SA and GFDL and was obtained from [http://en.qi-hardware.com/wiki/Hardware-Ben](http://en.qi-hardware.com/wiki/Hardware-Ben) diff --git a/docs/How To Submit A Change To This Wiki.md b/docs/How To Submit A Change To This Wiki.md new file mode 100644 index 0000000000..995f35281d --- /dev/null +++ b/docs/How To Submit A Change To This Wiki.md @@ -0,0 +1,55 @@ +How To Submit A Change To This Wiki +=================================== + +Clone this repo and: +-------------------- + + git clone https://gogs.librecmc.org/libreCMC/libreCMC-wiki.git + +then + + git push + +or + + git request-pull -p + +### git push ( In Gogs ) + +Clone the upstream repo in Gogs, then clone to your computer: + + git clone https://yourUserName@yourURL + +Add upstream repo to be able to rebase to upstream point commit: + + git remote add upstream https://gogs.librecmc.org/libreCMC/libreCMC-wiki.git + (git checkout -b optionalBranchName) + git push (--all) + +Create Push Request in Gogs: + +* Press the little green PR button in your own repo +* Or go to + +### git request-pull -p ( Anywhere ) + +Clone the upstream repo to your computer. + + git add changedFile.md + git commit ( -m Short info what changed ) + git log ( copy commit id ) + git request-pull -p (start) URL (end) + git request-pull -p (commit in upstream repo) URL master + +Example for piping output to haste: + + git request-pull -p b3b8926484feb37c33e5150facf315ef12b4612e https://gogs.librecmc.org/jonasbits2/libreCMC-wiki.git master | haste + +* Send to hastebin.com or any site you like +* Paste link in IRC channel + +#### Links + +* +* + diff --git a/docs/How_To_Build_libreCMC.md b/docs/How_To_Build_libreCMC.md new file mode 100644 index 0000000000..2a5c780a8f --- /dev/null +++ b/docs/How_To_Build_libreCMC.md @@ -0,0 +1,73 @@ +# libreCMC build HOWTO + +This generic documentation is to help aid those who want to build libreCMC firmware images from source code. While this +documentation is not an exhaustive source of information, it should help those who would like to build their own firmware images +or would like to develop firmware based upon libreCMC. + +While libreCMC does allow for building for other targets, not all of them have been tested to work with libreCMC and are not officially supported if they are not mentioned on the libreCMC wiki. + +libreCMC is licensed under the GPLv2 and contains code from other free software projects. Some code may be licensed under other free software licenses and will be noted. All software is to be distributed under the terms of the GPLv2 or their respective free software licenses. + +## What do I need to get started? + +* GNU/Linux distro (Trisquel, *buntu, Fedora or others) +* GNU GCC / GCC-C++ +* build-essential (Debian-based distro) or base-devel (Parabola) +* flex +* gawk +* wget +* unzip +* ncurses-dev (ncurses5-devel, etc..) +* libghc-zlib-dev +* libssl-dev +* patch +* perl5 +* subversion +* git-core +* 8 - 10 GB of disk space +* 4 GB of RAM (8 GB or more is recommended) + +## Building libreCMC + +1) Get the latest libreCMC source code: + +`git clone https://gogs.librecmc.org/libreCMC/libreCMC.git` + +or download a [release](/releases) + +If you want to build packages found in libreCMC's package feed, update and install the make files +by running the following from `$SRC_ROOT`: + +`./scripts/feeds update && ./scripts/feeds install -a` + +This will pull the makefiles for the package feed and make them available for selection +when configuring your build of libreCMC. + +2) Configure libreCMC for your device. + + `make menuconfig` + + When configuring libreCMC for your device, it is imperative that the right target and profile are selected. Currently, we only _officially_ support the AR71XX target and the TP-Link TL-MR3020 and Netgear WNDR3800. If you want other packages, please keep in mind that these devices don't have very much in terms of flash ROM and your selection of packages may not work properly. Generally, a good default configuration includes: + + + * luci : Collections -> luci + luci -> protocols -> luci-proto-relayd + * Networking : wpa-cli + wpa-supplicant + iw + * Utilities : Editors -> Nano + +3) When done configuring, run: + + `make` + + If the build fails, type: + + `make V=s` + + if there are missing dependencies in your build environment, please install them and then run `make`. + +4) If the build exits without any errors, you should have a new image in: + + `$SRC_ROOT/bin/$BUILD_TARGET/librecmc-$BUILD_TARGET-generic-$TARGET_PROFILE-$VERSION-$FS_TYPE-factory.bin` + + Where `$BUILD_TARGET = target (ex. ar71xx)`, `$TARGET_PROFILE = device`, `$VERSION = device version (some don't any)` + +5) Flash the newly built image (if you are confident). libreCMC project is not responsible for bricked devices. diff --git a/docs/LICENSE.md b/docs/LICENSE.md new file mode 100644 index 0000000000..3b3f0b4608 --- /dev/null +++ b/docs/LICENSE.md @@ -0,0 +1,430 @@ +``` +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. + +``` \ No newline at end of file diff --git a/docs/List_of_Tested_Hardware.md b/docs/List_of_Tested_Hardware.md new file mode 100644 index 0000000000..a12c4d165a --- /dev/null +++ b/docs/List_of_Tested_Hardware.md @@ -0,0 +1,22 @@ +# List of Tested Devices + +| Device Name | Contributor | Bootloader Flashed? | +|-------------------------------------|:-------------:|------:| +| Netgear WNDR3700 v1 | orly_owl | ??? | +| TP-Link TL-WA901ND v3 | jonasbits | ??? | +| TP-Link TL-WR710N v2.0 | jonasbits | ??? | +| TP-Link TL-WR741ND v1.8 | yang | ???| +| TP-Link TL-WR841ND v5.2 | orly_owl | ??? | +| TP-Link TL-WR841ND v8.2 | RISCi_ATOM, yang| Yes, u-boot_mod| +| TP-Link TL-WR842ND v2.0 | zeus | No | +| TP-Link TL-WR1043ND v1.8| orly_owl | ??? | +| TP-Link TL-WR1043ND v2.1| RISCi_ATOM | ??? | +| D-Link DGL-5500 vA1 rm' wifi card| RISCi_ATOM | ??? | +| Western Digital MyNet N750 | orly_owl | ??? | + +Please note that not all of the devices on the above list are officially supported by the libreCMC +project. In order for a device to be officially supported, it needs to meet the following rules: + +* libreCMC must be flashable from stock firmware (without the usage of non-free software). +* The bootloader must be free software and flashable with a serial cable + Ethernet cable or from within libreCMC. +* Components including( wifi, switch, video, etc..) must not require blobs to work. diff --git a/docs/Router_Reset_Instructions.md b/docs/Router_Reset_Instructions.md new file mode 100644 index 0000000000..c57adf03a4 --- /dev/null +++ b/docs/Router_Reset_Instructions.md @@ -0,0 +1,53 @@ +# libreCMC Router Reset + +## Hard reset + +### Manual way (if you can’t access the web interface) + +1. Power off the router. + +2. Power on the router. + +3. As soon as the SYS light (the gear) flashes, hold down the reset button until the +SYS LED flashes faster. + +4. Stop Network-Manager or other network configuration services. + +5. Plug in an ethernet cable from your machine to one of the LAN ports. + +6. Set your computer’s IP address to 192.168.10.2 + +7. `telnet 192.168.10.1` (192.168.1.1 on pre v1.3.1 devices). + With v1.3.4+ devices, telnet is disabled. use ssh: + `ssh root@192.168.10.1` + +8. At the shell prompt, type: +`firstboot` + +9. After you have confirmed that you want to reset everything your need to reboot the router: +`reboot` <- It can manually be turned off too. + +### Resetting via web interface + +1. Login into the router via : 192.168.10.1 (or 192.168.1.1, depending on your configuration). + +2. Navigate to: System -> Backup / Flash Firmware + +3. Click : "Preform Reset" + +Note: After resetting the router, it will be in a default state (wireless will be disabled, no password +is set, ip-forwarding is disabled and telnet is enabled and the default IP should be 192.168.10.1) +It is recommended that you re-load the default configuration: + +# Restoring old configurations + +1. Make sure you have your network-manager turned on + +2. Log into the router via : 192.168.10.1 + +3. Navigate to : System -> Backup / Flash Firmware + +4. By "Restore Backup" , click the browse button and select the libreCMC configuration backup (*.tar.gz). + + + diff --git a/docs/Supported_Hardware.md b/docs/Supported_Hardware.md new file mode 100644 index 0000000000..97fc6266a8 --- /dev/null +++ b/docs/Supported_Hardware.md @@ -0,0 +1,37 @@ +# libreCMC supported Hardware + +### Buffalo +* [WZR-HP-G300NH](/WZR_HP_G300NH.md) +* WHR-HP-G300NH + +### Netgear + +* [WNDR3800](/WNDR3800.md) + +### TP-link + +* [TL-MR3020 v1](/TL_MR3020.md) +* [TL-WR741ND](/TL_WR741ND.md) +* [TL-WR841ND](/TP_WR841ND.md) +* [TL-WR842ND](/TL_WR842ND.md) +* [TL-WR1043ND](/TL_WR1043ND) + +### ThinkPenguin +* [TPE-NWIFIROUTER2](/TPE_NWIFIROUTER2.md) +* [TPE-R1100](/TPE_R1100.md) + +### Qi-Hardware + +* [Ben Nanonote](/Ben_Nanonote.md) + +## Tested Hardware + +[List of tested hardware](/List_of_Tested_Hardware.md) + +# libreCMC unofficially supported Hardware + +### D-Link + +* DGL-5500 a1 : Ships with non-free wifi card, but can be replaced with a free one. Has a mini-pci-e card slot. + +#####Please note that other targets may work; we are **NOT** responsible for **ANY** _bricked_ devices. diff --git a/docs/TL_MR3020.md b/docs/TL_MR3020.md new file mode 100644 index 0000000000..27a0188cfb --- /dev/null +++ b/docs/TL_MR3020.md @@ -0,0 +1,42 @@ +# TP-Link : TL-MR3020 + +The TL-MR3020 is a versatile device with the following specs: + +* SoC : Atheros AR7240 +* RAM: 32 MB +* Flash: 4MB +* NIC: 100BASE-X + +Please see the libreCMC [build documentation](/wiki/How-To-Build-libreCMC) for build instructions. + +## Flashing from factory (virgin) + +### Using Web GUI (Recommended) + +1) Set TL-MR3020 Mode Switch to either 3G/4G or WISP + +2) Connect to the TL-MR3020 router via Ethernet cable + +3) Open IP address 192.168.0.254 + +4) log in to the router's web GUI (default login/password: admin / admin) + +5) overwrite the factory firmware by installing the openwrt-ar71xx-generic-tl-mr3020-v1-squashfs-factory.bin firmware image like a regular firmware update. + +Wait for the progress bar to finish twice (the device will reset itself in the process), and proceed with basic configuration as with any fresh libreCMC install. + +### Flashing from libreCMC Web GUI + +1) Connect device to ethernet port on your computer and set the ip address of your machine to 192.168.1.10 + +2) Open 192.168.1.1 in a browser. + +3) Go to: System -> Backup/Flash Firmware + +4) Click the "browse" button under the _Flash New Firmware image_ section. + +5) Upload a firmware image with : librecmc-_target_-generic-_profile_-squashfs-factory.bin + +6) wait for the web interface to appear again (unless you chose to flash an image without it). + +# Needs more editing ;) \ No newline at end of file diff --git a/docs/TL_WR1043ND.md b/docs/TL_WR1043ND.md new file mode 100644 index 0000000000..91dde45f1a --- /dev/null +++ b/docs/TL_WR1043ND.md @@ -0,0 +1,28 @@ +# TL-WR1043ND + +## Hardware Specs: + +v1.x + +* SoC : Atheros AR9103 +* Flash ROM : 8 MiB +* RAM : 32 MB +* USB : 1 +* Special: 10/1000 switch + +v2.x + +* SoC : Qualcomm Atheros QCA9558 +* Flash ROM : 8 MiB +* RAM : 64 MB +* USB : 1 +* Special: 10/1000 switch + +## Supported Versions: + +* v1.x +* v2.x + +Reset instructions + +??? diff --git a/docs/TL_WR741ND.md b/docs/TL_WR741ND.md new file mode 100644 index 0000000000..3e08be0ce0 --- /dev/null +++ b/docs/TL_WR741ND.md @@ -0,0 +1,15 @@ +# TP-Link TL-WR741ND + +## Specs + +* SoC : Atheros AR7240 @ 350 MHz +* RAM: 32 MB +* Flash : 4 MB + +## Versions Supported + +* v1 - v2, v4.20 - 4.27 + +## Versions **NOT** supported + +* v2.1 - v3.1 + v4.0 diff --git a/docs/TL_WR841ND.md b/docs/TL_WR841ND.md new file mode 100644 index 0000000000..feac3fc517 --- /dev/null +++ b/docs/TL_WR841ND.md @@ -0,0 +1,25 @@ +# TP-WR841ND + +## Specs + +* SoC : Atheros AR9341 +* RAM: 32 MB +* Flash: 4 MB + +## Versions Supported + +* v5.x +* v8.x +* v9.x +* v10.x <-- may need to be tftp flashed +* v11.x <-- +* v12.x <-- + + +DO NOT BUY v13!!! V13 contains a mediatek +chipset, which requires a non-free firmware +blob. + +## Reset instructions + +??? diff --git a/docs/TL_WR842ND.md b/docs/TL_WR842ND.md new file mode 100644 index 0000000000..c831e83023 --- /dev/null +++ b/docs/TL_WR842ND.md @@ -0,0 +1,41 @@ +# TL-WR842ND + +## Specs + +* SoC : AR7241 (v1) AR9341 (v2) +* RAM: 32 MB +* Flash: 8 MB + +## Versions Supported + +* v1 +* v2 + +## Flashing TL-WR842ND using tftp recovery mode + +* Press and hold WPS/Reset button, and power on router +* Wait until Lock LED lights up before releasing WPS/Reset button +* Router has IP address: 192.168.0.86 +* Router is standing by for a tftp server to appear with `wr842nv2_tp_recovery.bin` file using IP address: 192.168.0.66 + +### Example commands using [Parabola GNU/Linux](https://www.parabola.nu/) + +Configure PC IP address to `192.168.0.66` + + ip addr add 192.168.0.66/24 dev enp3s0 + +Copy downloaded image into tftp server directory also renaming it to `wr842nv2_tp_recovery.bin` + + cp librecmc-ar71xx-generic-tl-wr842n-v2-squashfs-factory.bin /srv/tftp/wr842nv2_tp_recovery.bin + +Start tftpd + +`systemctl start tftpd.socket` + +`systemctl start tftpd.service` + +* After a short time all LEDs will flash once then router will reboot normally + +## Reset instructions + +??? \ No newline at end of file diff --git a/docs/TPE_NWIFIROUTER2.md b/docs/TPE_NWIFIROUTER2.md new file mode 100644 index 0000000000..ead1ab4bd4 --- /dev/null +++ b/docs/TPE_NWIFIROUTER2.md @@ -0,0 +1,20 @@ +# ThinkPenguin [TPE-NWIFIROUTER2](https://www.thinkpenguin.com/gnu-linux/free-software-wireless-n-broadband-router-gnu-linux-tpe-nwifirouter2) + +## Specs + +* SoC : Atheros AR9341 +* RAM: 32 MB +* Flash: 4 MB + +## Versions Supported + +* v2 + +## Notes: + +* This router is a re-branded and re-flashed Rosewill RNX-N300RT. The Rosewill RNX-N300RT uses the same board found in the +TL-WR841N[D] v8.x. The stock RNX-N300RT ships with DRM and CAN NOT be flashed without non-free software (unless you have +a chip clip and SPI flasher). Some versions (v1) requires the flash chip to be removed before an SPI programmer can be used. +ThinkPenguin's offering ships with libreCMC, does not ship with DRM and can be fully re-programmed. + +* The names of the firmware images for this device are `librecmc-ar71xx-generic-tl-wr841-v8-squashfs-*` diff --git a/docs/TPE_R1100.md b/docs/TPE_R1100.md new file mode 100644 index 0000000000..25e33d0db4 --- /dev/null +++ b/docs/TPE_R1100.md @@ -0,0 +1,25 @@ +# Think Penguin [TPE-R1100 mini WiFi Router](https://www.thinkpenguin.com/TPE-R1100) + +## Specs + +* SoC: Atheros AR9331 +* RAM: 64M +* Flash: 16M +* NIC: 2 10/100 Ethernet Ports +* USB: 1 +* WiFi: Atheros 802.11b/g/n 2.4Ghz +* GPIO: 3 General Purpose and one switch. +* Power: 5v USB + +The TPE-R1100 is a general purpose mini WiFi router +that can be used for a wide range of applications. +Some common uses include: + +* Route all traffic over a VPN when on the go. +* WiFi to ethernet bridge. +* A small web server. +* IRC bouncer. +* Meshnet node (CJDNS, Batman...). + + + diff --git a/docs/WNDR3800.md b/docs/WNDR3800.md new file mode 100644 index 0000000000..f40a19b256 --- /dev/null +++ b/docs/WNDR3800.md @@ -0,0 +1,11 @@ +# Netgear WNDR3800 + +## Specs + +* SoC : Atheros AR7161 rev 2 +* RAM: 128 MB +* Flash: 16 MB + +## Versions Supported + +* v1.x diff --git a/docs/WZR_HP_G300NH.md b/docs/WZR_HP_G300NH.md new file mode 100644 index 0000000000..ab3aa8e340 --- /dev/null +++ b/docs/WZR_HP_G300NH.md @@ -0,0 +1,13 @@ +# Buffalo WZR-HP-G300NH +This device is scheduled to be supported in the upcoming version 1.3.1 of libreCMC. + +## Specs + +* SoC : Atheros AR9132 +* RAM: 64 MB +* Flash: 32 MB + +## Versions Supported + +More info soon. + diff --git a/docs/Welcome.md b/docs/Welcome.md new file mode 100644 index 0000000000..30fb4a0bf9 --- /dev/null +++ b/docs/Welcome.md @@ -0,0 +1,71 @@ +# libreCMC : The libre Embedded GNU/Linux Distro + +The libreCMC project is a set of fully [free](https://www.gnu.org/philosophy/free-sw.en.html) [embedded](/wiki/embedded) Operating Systems +that give users the freedom to control their computing. Our primary project is an embedded GNU/Linux-libre +distro that is based upon the upstream OpenWRT/LEDE project. The main difference between OpenWRT/LEDE and libreCMC +are the fact that the project removes all [non-free](https://www.gnu.org/philosophy/categories.en.html#non-freeSoftware) packages, drivers and firmware blobs where the sources are not available under a free software license. + +## Why would I use libreCMC? + +Full control over your computing! In many cases, a variety of embedded devices require components where the sources +are not available to the community under a Free Software license. These non-free parts mean that the community can't +fix bugs, security flaws or even use a newer kernel because drivers don't work with newer versions of the kernel. By using these non-free parts,the user is at the mercy of the OEM or manufacture to maintain support for newer drivers that work with newer versions of the Linux™ kernel. + +# Quick Start Build Guide + +1) Checkout libreCMC + +`git clone https://gogs.librecmc.org/libreCMC/libreCMC.git` + +2) Enter the libreCMC directory (from now on referred by `$SRC_ROOT`) + +`cd $SRC_ROOT` + +3) Configure the build for the [supported device](/wiki/Supported-Hardware) and +the packages that you may want to have. Some targets may have a very limited amount +of flash (primary storage) and may not have the room for certain configurations of +packages. + +Also, in order to build libreCMC, make sure that you have all needed [dependencies](/wiki/How-To-Build-libreCMC#what-do-i-need-to-get-started). +After having installed all the necessary dependencies run: + +`make menuconfig` + +This will bring up the ncurses menuconfig interface for configuring libreCMC. + +A good default configuration for many people would be to include: + +* Luci -> luci, luci-ssl +* Base System -> ca-bundle, sqm-scripts[-extra] + +4) Actually start the build: + +`make` : To speed things up, you can add a few more threads to the build by using `make -j4` + +5) Wait.... + +Depending on the machine you have access to and the configuration you selected, it will take sometime to build libreCMC. + +a) What if something goes wrong with the build? Run: + +`make V=s` : This will allow for the build to be debugged. Sometimes a source package mirror is down or a dependency is missing. This +will allow us to figure out what is going wrong. + + +b) The build finished, but there is no image for my device! If you select more packages than can fit in flash, then some packages will +need to be removed from the configuration. After removing some packages, start the build again. Be careful when removing packages from +the configuration. Some packages are very important for basic functionality or are needed for other packages in the base system. + +If you have a device that has <8M of flash, then try removing `Base System -> opkg*, ca-bundle`. + + +6) If everything went OK, there should be a new image in `$SRC_ROOT/bin/targets/$TARGET/generic/` + + +# Where do I go from here? + +Well, it depends on many factors. libreCMC can be used for many different use cases. If you need help with libreCMC, help can be found on IRC using: + +server :`FreeNode` + +channel : `#libreCMC` \ No newline at end of file diff --git a/docs/embedded.md b/docs/embedded.md new file mode 100644 index 0000000000..191dd17367 --- /dev/null +++ b/docs/embedded.md @@ -0,0 +1,15 @@ +# Embedded Systems +Embedded can mean different things to many people. The Wikipedia [definition](https://en.wikipedia.org/wiki/Embedded_system) is: + +> An embedded system is a computer system with a dedicated function within a larger mechanical or electrical system, often with real-time computing constraints. +> ... +> Examples of properties of typically embedded computers when compared with general-purpose counterparts are low power consumption, small size, rugged operating ranges, and low per-unit cost. + +The libreCMC project's definition is: + +> +A device or system with very few resources and is designed to be run for long stretches of time without user intervention. + +One of the main goals of the libreCMC project is to keep things really small in terms of operating footprint (storage and RAM used). Many of the devices that the project supports have as little as 4M of flash and 16M of RAM. In this scope, many SBCs (Single Board Computers) are well outside this range with some having more resources than an average desktop 10+ years ago. + +# Page needs more editing! diff --git a/docs/old/Save_WiFi.md b/docs/old/Save_WiFi.md new file mode 100644 index 0000000000..9efd7c88cf --- /dev/null +++ b/docs/old/Save_WiFi.md @@ -0,0 +1,24 @@ +# Will you help us save WiFi ? + +For as long as the libreCMC and LibreWRT projects have existed, their core focus has been to +bring Free Software to embedded devices, some of which have WiFi chipsets. While the project(s) +core goals have not changed very much over the last few years, the landscape of WiFi enabled devices +has exploded. Many of the radios in these devices went from being single-purpose radios that can only +operate within certain ranges to modifiable SDRs that can be changed. While having the freedom to change +one's own hardware is important, it is also important to operate radio equipment within regulatory laws. + +Since a few individuals have operated devices outside of regulations, the FCC and other regulatory bodies are proposing tighter +restrictions on hardware that has WiFi or SDRs. These new restrictions would include a full lockout of third-party software +and prevent users from updating or running new software on hardware they own. With these new digital locks, hardware vendors +will exercise control over the user by preventing new innovative functionality or even preventing users from applying critical security patches. + +These new regulations won't work the way they are intended to and they should not be required. Users with the technical knowledge +will still be able to get around the restrictions and load their own software. Most free software projects +already put safeguards in place so that users can't accidentally violate regulatory rules that apply to their WiFi or SDR devices, unless +they choose to remove them on purpose. Instead of punishing everyone in the Free Software community for the actions of a few, individuals +who operate devices outside of regulations should be fined instead of taking away everyone's freedom. + +The libreCMC project and other members of the Free Software community would like to ask everyone to send a comment +to the FCC about these new proposals and why they won't help fix the misuse of WiFi or SDRs. More information +about this issue and how to submit comments can be found at [SaveWiFi.org](http://savewifi.org). + diff --git a/docs/testing.md b/docs/testing.md new file mode 100644 index 0000000000..17b44d14da --- /dev/null +++ b/docs/testing.md @@ -0,0 +1,3 @@ +# This is a sample file! + +Just testing a symlink'ed wiki! -- 2.25.1