From 54fe34f34b61c6b261b90f765cc5546937ce1d74 Mon Sep 17 00:00:00 2001 From: Christian Lamparter Date: Thu, 7 Aug 2014 20:00:14 +0200 Subject: [PATCH] carl9170 firmware: update README.md New version of the README in markdown. Includes additional information about contact and firmware configuration. Signed-off-by: Christian Lamparter --- README | 39 --------------------------------------- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+), 39 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 10f8e94..0000000 --- a/README +++ /dev/null @@ -1,39 +0,0 @@ -Community AR9170 Linux firmware ------------------------ - -This is the firmware for the Atheros ar9170 802.11n devices. - -To build the firmware you will need an SH-2 toolchain. -You can build your own toolchain: - -make -C toolchain - -but be aware that this will take some time and requires -about 2.4 GiB disk space. - -The resulting firmware, carl9170.fw, can be used only -with the carl9170 Linux driver. - -After getting a toolchain, you will need to get more -tools & libs: - - * gcc 4.7+ - - * gperf, bison/flex - - * cmake 2.8.4+ - -afterwards, simply execute: - -autogen.sh - -to start the configuration and build process. - -if you want to "install" your own firmware, you can either -do this manually, or by executing: - -autogen.sh install - -This will place a copy with the right filename [adds API rev] -into /lib/firmware/[the default path on most Distributions]. - diff --git a/README.md b/README.md new file mode 100644 index 0000000..1521488 --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# Community AR9170 Linux firmware + +## Introduction + +This is the firmware for the Atheros ar9170 802.11n devices. +The firmware, carl9170.fw, can be used with the carl9170 Linux +driver or the tools supplied in the repository. + +## Build + +### Build Toolchain + +To build the firmware you will need an SH-2 toolchain. +You can use the makefile in this repository to build +your own toolchain: + +`# make -C toolchain` + +but be aware that this will take some time and requires +about 3-4 GiB disk space. + +### Build Firmware Image + +The firmware configuration and build process requires the following +tools and libraries: + + * gcc 4.7+ + + * gperf, bison/flex + + * cmake 2.8.4+ + +to start the configuration, run: + +`# autogen.sh` + +The configuration is based on the Linux's KConfig utility CLI. +For each configurable option, a prompt will appear. To choose +the default/previous option simply hit ``-key on your +keyboard. + +### Install Firmware + +if you want to "install" your own firmware, you can either +do this manually, or by executing: + +`# autogen.sh install` + +This will place a copy with the right filename [adds API rev] +into /lib/firmware/[the default path on most Distributions]. + +## Contact + +If you have any questions, reports or patches, you should write +to . -- 2.31.1