* [PATCH wpan-misc] website: introduce asciidoc website generation framework @ 2014-12-12 13:47 Alexander Aring 2014-12-12 13:47 ` [PATCH wpan-misc] website: inital commit Alexander Aring 0 siblings, 1 reply; 7+ messages in thread From: Alexander Aring @ 2014-12-12 13:47 UTC (permalink / raw) To: linux-wpan; +Cc: Alexander Aring Hi, this series introduce some files to build some website with asciidoc. Feel free to add own information and then we simple update the website of http://wpan.cakelab.org/. - Alex Alexander Aring (1): website: inital commit website/.gitingore | 1 + website/Makefile | 5 +++ website/index.txt | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 134 insertions(+) create mode 100644 website/.gitingore create mode 100644 website/Makefile create mode 100644 website/index.txt -- 2.1.3 ^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH wpan-misc] website: inital commit 2014-12-12 13:47 [PATCH wpan-misc] website: introduce asciidoc website generation framework Alexander Aring @ 2014-12-12 13:47 ` Alexander Aring 2014-12-12 14:03 ` Stefan Schmidt 2014-12-12 14:08 ` Stefan Schmidt 0 siblings, 2 replies; 7+ messages in thread From: Alexander Aring @ 2014-12-12 13:47 UTC (permalink / raw) To: linux-wpan; +Cc: Alexander Aring This is the initial commit for the website asciidoc framework of: http://wpan.cakelab.org/ Signed-off-by: Alexander Aring <alex.aring@gmail.com> --- website/.gitingore | 1 + website/Makefile | 5 +++ website/index.txt | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 134 insertions(+) create mode 100644 website/.gitingore create mode 100644 website/Makefile create mode 100644 website/index.txt diff --git a/website/.gitingore b/website/.gitingore new file mode 100644 index 0000000..dcaf716 --- /dev/null +++ b/website/.gitingore @@ -0,0 +1 @@ +index.html diff --git a/website/Makefile b/website/Makefile new file mode 100644 index 0000000..cc090bc --- /dev/null +++ b/website/Makefile @@ -0,0 +1,5 @@ +all: + asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt + +clean: + rm index.html diff --git a/website/index.txt b/website/index.txt new file mode 100644 index 0000000..a7ab4bb --- /dev/null +++ b/website/index.txt @@ -0,0 +1,128 @@ +linux-wpan +========== +Mailinglist <linux-wpan@vger.kernel.org> + +wpan-tools +---------- + +To access the nl802154 netlink inteface you will need the wpan-tools. + +Dependencies: + +- netlink library http://www.infradead.org/~tgr/libnl/[libnl]. + +These tools contains: + +[horizontal] +*iwpan*:: based on the wireless http://wireless.kernel.org/en/users/Documentation/iw[iw] tool. + +Download +~~~~~~~~ +For the last release check out http://wpan.cakelab.org/releases/[releases] page: + +http://wpan.cakelab.org/releases/ + +Supported Hardware +------------------ + +.Supported 802.15.4 Hardware +[cols="3,4,2,^2,12",options="header"] +|============================================================= +|Transceiver |Supported |Driver | Bus |Where to buy +|at86rf230 |no |at86rf230? | SPI | +|at86rf231 |yes |at86rf230 | SPI | http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. +|at86rf233 |yes |at86rf230 | SPI | http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs] +|at86rf212 |yes |at86rf230 | SPI | +|atusb |not mainline yet |atusb | USB | http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. +|============================================================= + +How-To's +-------- + +This section describes various How-To's. +Per default you should have already a node type wpan interface. + +//////// +af802154 +~~~~~~~ + +//////// +6LoWPAN +~~~~~~~ + +Set some valid pan_id, 802.15.4 default is 0xffff which means not assigned: + +--------------------------------------------------------------------- +iwpan dev wpan0 set pan_id 0xbeef +--------------------------------------------------------------------- + +Currently you need to setup the 6LoWPAN interface manually: + +--------------------------------------------------------------------- +ip link add link wpan0 name lowpan0 type lowpan +--------------------------------------------------------------------- + +That's it! Now you have some lowpan0 interface with a 6LoWPAN 1280 MTU which runs on top the wpan interface. +As default you have a default link-local address based on the MAC (extended address). + +Note: we don't support any case of short-addresses right now. This is a complicated issue with the IPv6 neighbour discovery cache. +Of course we supporting broadcast frames via short-addresses but nothing more in 802.15.4 6LoWPAN. +Only extended address handling is supported right now. + +Sniffing +~~~~~~~~ + +To sniff first remove all wpan interface which sits on top of the wpan phy. +You will get a list of all current running phy interface with: + +--------------------------------------------------------------------- +iwpan dev +--------------------------------------------------------------------- + +then delete all interfaces with: + +--------------------------------------------------------------------- +iwpan dev $IFNAME del +--------------------------------------------------------------------- + +Finally create a monitor interface: + +--------------------------------------------------------------------- +iwpan phy wpan-phy0 interface add monitor%d type monitor +--------------------------------------------------------------------- + +Then bring this interface up and run wireshark, tcpdump, etc... on it. + +////// +Foren6 +^^^^^^ + +////// +Developing +---------- + +Current developing repository is http://git.kernel.org/cgit/linux/kernel/git/bluetooth/bluetooth-next.git[bluetooth-next]. +All patches should be send to <linux-wpan@vger.kernel.org> and based on bluetooth-next. + +For wpan-tools checkout the https://github.com/linux-wpan/wpan-tools[wpan-tools] repository. Also send patches to <linux-wpan@vger.kernel.org> for it with a "wpan-tools" tag. +The same for https://github.com/linux-wpan/wpan-misc[wpan-misc]. + +Rework +~~~~~~ + +Currently a rework of 802.15.4 subsystem is in progress. + +The rework will contains a new netlink API and a general handling about frame creation and parsing. + +.Supported 802.15.4 Hardware +[options="header"] +|======================================= +|Milestone | Description | state +|1. nl802154 | new netlink framework | [green]#mostly done# +|2. crypto-layer | accessable over nl802154 and tools | [red]#TODO# +|3. frame parsing | remove bugs, more generical | [red]#TODO# +|======================================= + +For the nl802154 framework you will need the wpan-tools, older kernels need lowpan-tools but this is not recommended. + +// vim: set syntax=asciidoc: -- 2.1.3 ^ permalink raw reply related [flat|nested] 7+ messages in thread
* Re: [PATCH wpan-misc] website: inital commit 2014-12-12 13:47 ` [PATCH wpan-misc] website: inital commit Alexander Aring @ 2014-12-12 14:03 ` Stefan Schmidt 2014-12-12 14:20 ` Alexander Aring 2014-12-12 14:08 ` Stefan Schmidt 1 sibling, 1 reply; 7+ messages in thread From: Stefan Schmidt @ 2014-12-12 14:03 UTC (permalink / raw) To: 'Alexander Aring', linux-wpan Hello. Good to see this getting a bit more documented. Some remarks inline. On 12/12/14 14:47, Alexander Aring wrote: > This is the initial commit for the website asciidoc framework of: > > http://wpan.cakelab.org/ > > Signed-off-by: Alexander Aring <alex.aring@gmail.com> > --- > website/.gitingore | 1 + > website/Makefile | 5 +++ > website/index.txt | 128 > +++++++++++++++++++++++++++++++++++++++++++++++++++++ > 3 files changed, 134 insertions(+) > create mode 100644 website/.gitingore > create mode 100644 website/Makefile > create mode 100644 website/index.txt > > diff --git a/website/.gitingore b/website/.gitingore > new file mode 100644 > index 0000000..dcaf716 > --- /dev/null > +++ b/website/.gitingore > @@ -0,0 +1 @@ > +index.html > diff --git a/website/Makefile b/website/Makefile > new file mode 100644 > index 0000000..cc090bc > --- /dev/null > +++ b/website/Makefile > @@ -0,0 +1,5 @@ > +all: > + asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt > + > +clean: > + rm index.html > diff --git a/website/index.txt b/website/index.txt > new file mode 100644 > index 0000000..a7ab4bb > --- /dev/null > +++ b/website/index.txt > @@ -0,0 +1,128 @@ > +linux-wpan > +========== > +Mailinglist <linux-wpan@vger.kernel.org> > + > +wpan-tools > +---------- > + > +To access the nl802154 netlink inteface you will need the wpan-tools. > + > +Dependencies: > + > +- netlink library http://www.infradead.org/~tgr/libnl/[libnl]. Better name it libnl-3 here as it does not work with libnl-1 and libnl-2 > +These tools contains: > + > +[horizontal] > +*iwpan*:: based on the wireless > http://wireless.kernel.org/en/users/Documentation/iw[iw] tool. > + > +Download > +~~~~~~~~ > +For the last release check out > http://wpan.cakelab.org/releases/[releases] page: > + > +http://wpan.cakelab.org/releases/ > + > +Supported Hardware > +------------------ > + > +.Supported 802.15.4 Hardware > +[cols="3,4,2,^2,12",options="header"] > +|============================================================= > +|Transceiver |Supported |Driver | Bus |Where to buy > +|at86rf230 |no |at86rf230? | SPI | > +|at86rf231 |yes |at86rf230 | SPI | > http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of > stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact > http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. > +|at86rf233 |yes |at86rf230 | SPI | > http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs] > +|at86rf212 |yes |at86rf230 | SPI | > +|atusb |not mainline yet |atusb | USB | > http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of > stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact > http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. > +|============================================================= Maybe mention the other drivers we have mainline here as well? CC2520 and MRF24j40 are fully supported or not? As a sidenote I build and updated the firmware for my atusb and did some initial testing. Nothing on the RF side yet as I wait for more hardware to test against. I'm willing to bring this driver mainline and update it as needed. So far I only made sure that atusb and at86rf230 share the same header file for register defines to avoid duplication. Once I have other hardware I will test the RF side of things and start to work on asnyc xmit. Also need to talk to Werner if he is happy with the fw interface. After that I will send out a RFC for it. regards Stefan Schmidt ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH wpan-misc] website: inital commit 2014-12-12 14:03 ` Stefan Schmidt @ 2014-12-12 14:20 ` Alexander Aring 2014-12-12 14:34 ` Stefan Schmidt 0 siblings, 1 reply; 7+ messages in thread From: Alexander Aring @ 2014-12-12 14:20 UTC (permalink / raw) To: Stefan Schmidt; +Cc: linux-wpan On Fri, Dec 12, 2014 at 02:03:11PM +0000, Stefan Schmidt wrote: > Hello. > > Good to see this getting a bit more documented. Some remarks inline. > > On 12/12/14 14:47, Alexander Aring wrote: > >This is the initial commit for the website asciidoc framework of: > > > >http://wpan.cakelab.org/ > > > >Signed-off-by: Alexander Aring <alex.aring@gmail.com> > >--- > > website/.gitingore | 1 + > > website/Makefile | 5 +++ > > website/index.txt | 128 > >+++++++++++++++++++++++++++++++++++++++++++++++++++++ > > 3 files changed, 134 insertions(+) > > create mode 100644 website/.gitingore > > create mode 100644 website/Makefile > > create mode 100644 website/index.txt > > > >diff --git a/website/.gitingore b/website/.gitingore > >new file mode 100644 > >index 0000000..dcaf716 > >--- /dev/null > >+++ b/website/.gitingore > >@@ -0,0 +1 @@ > >+index.html > >diff --git a/website/Makefile b/website/Makefile > >new file mode 100644 > >index 0000000..cc090bc > >--- /dev/null > >+++ b/website/Makefile > >@@ -0,0 +1,5 @@ > >+all: > >+ asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt > >+ > >+clean: > >+ rm index.html > >diff --git a/website/index.txt b/website/index.txt > >new file mode 100644 > >index 0000000..a7ab4bb > >--- /dev/null > >+++ b/website/index.txt > >@@ -0,0 +1,128 @@ > >+linux-wpan > >+========== > >+Mailinglist <linux-wpan@vger.kernel.org> > >+ > >+wpan-tools > >+---------- > >+ > >+To access the nl802154 netlink inteface you will need the wpan-tools. > >+ > >+Dependencies: > >+ > >+- netlink library http://www.infradead.org/~tgr/libnl/[libnl]. > > Better name it libnl-3 here as it does not work with libnl-1 and libnl-2 > ok. I thought also about that. The original iw tool has backwards compat. to older libnl version. We could fix that inside the wpan-tools. But for now indeed libnl-3 is supported only. I will change to it and maybe we have also this backwards compat like iw. > >+These tools contains: > >+ > >+[horizontal] > >+*iwpan*:: based on the wireless > >http://wireless.kernel.org/en/users/Documentation/iw[iw] tool. > >+ > >+Download > >+~~~~~~~~ > >+For the last release check out > >http://wpan.cakelab.org/releases/[releases] page: > >+ > >+http://wpan.cakelab.org/releases/ > >+ > >+Supported Hardware > >+------------------ > >+ > >+.Supported 802.15.4 Hardware > >+[cols="3,4,2,^2,12",options="header"] > >+|============================================================= > >+|Transceiver |Supported |Driver | Bus |Where to buy > >+|at86rf230 |no |at86rf230? | SPI | > >+|at86rf231 |yes |at86rf230 | SPI | > >http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of > >stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact > >http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. > >+|at86rf233 |yes |at86rf230 | SPI | > >http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs] > >+|at86rf212 |yes |at86rf230 | SPI | > >+|atusb |not mainline yet |atusb | USB | > >http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of > >stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact > >http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. > >+|============================================================= > > Maybe mention the other drivers we have mainline here as well? CC2520 and > MRF24j40 are fully supported or not? Don't know about these transceivers I have CC2520 here but these are buildin inside some contiki nodes and I don't have any pinout headers for these. Specially MRF24j40 have some different types and I don't know which type is now supported. The driver maintainers can send patches to linux-wpan and I will apply changes to wpan-misc and generate a new website. For futher maybe we should add some "features" collumn because many of them doesn't support all driver callbacks. > > As a sidenote I build and updated the firmware for my atusb and did some > initial testing. Nothing on the RF side yet as I wait for more hardware to > test against. I'm willing to bring this driver mainline and update it as > needed. So far I only made sure that atusb and at86rf230 share the same > header file for register defines to avoid duplication. ok. > > Once I have other hardware I will test the RF side of things and start to > work on asnyc xmit. Also need to talk to Werner if he is happy with the fw > interface. After that I will send out a RFC for it. > ok. - Alex ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH wpan-misc] website: inital commit 2014-12-12 14:20 ` Alexander Aring @ 2014-12-12 14:34 ` Stefan Schmidt 0 siblings, 0 replies; 7+ messages in thread From: Stefan Schmidt @ 2014-12-12 14:34 UTC (permalink / raw) To: Alexander Aring, Stefan Schmidt; +Cc: linux-wpan Hello. On 12/12/14 15:20, Alexander Aring wrote: > On Fri, Dec 12, 2014 at 02:03:11PM +0000, Stefan Schmidt wrote: >> Hello. >> >> Good to see this getting a bit more documented. Some remarks inline. >> >> On 12/12/14 14:47, Alexander Aring wrote: >>> This is the initial commit for the website asciidoc framework of: >>> >>> http://wpan.cakelab.org/ >>> >>> Signed-off-by: Alexander Aring <alex.aring@gmail.com> >>> --- >>> website/.gitingore | 1 + >>> website/Makefile | 5 +++ >>> website/index.txt | 128 >>> +++++++++++++++++++++++++++++++++++++++++++++++++++++ >>> 3 files changed, 134 insertions(+) >>> create mode 100644 website/.gitingore >>> create mode 100644 website/Makefile >>> create mode 100644 website/index.txt >>> >>> diff --git a/website/.gitingore b/website/.gitingore >>> new file mode 100644 >>> index 0000000..dcaf716 >>> --- /dev/null >>> +++ b/website/.gitingore >>> @@ -0,0 +1 @@ >>> +index.html >>> diff --git a/website/Makefile b/website/Makefile >>> new file mode 100644 >>> index 0000000..cc090bc >>> --- /dev/null >>> +++ b/website/Makefile >>> @@ -0,0 +1,5 @@ >>> +all: >>> + asciidoc -b html5 -a icons -a toc2 -a theme=flask index.txt >>> + >>> +clean: >>> + rm index.html >>> diff --git a/website/index.txt b/website/index.txt >>> new file mode 100644 >>> index 0000000..a7ab4bb >>> --- /dev/null >>> +++ b/website/index.txt >>> @@ -0,0 +1,128 @@ >>> +linux-wpan >>> +========== >>> +Mailinglist <linux-wpan@vger.kernel.org> >>> + >>> +wpan-tools >>> +---------- >>> + >>> +To access the nl802154 netlink inteface you will need the wpan-tools. >>> + >>> +Dependencies: >>> + >>> +- netlink library http://www.infradead.org/~tgr/libnl/[libnl]. >> Better name it libnl-3 here as it does not work with libnl-1 and libnl-2 >> > ok. I thought also about that. > > The original iw tool has backwards compat. to older libnl version. We > could fix that inside the wpan-tools. But for now indeed libnl-3 is > supported only. I will change to it and maybe we have also this > backwards compat like iw. I would say that really depends on how ugly this compat would be and how many people are actually need it. For now using libnl-3 only is fine I would say. >>> +These tools contains: >>> + >>> +[horizontal] >>> +*iwpan*:: based on the wireless >>> http://wireless.kernel.org/en/users/Documentation/iw[iw] tool. >>> + >>> +Download >>> +~~~~~~~~ >>> +For the last release check out >>> http://wpan.cakelab.org/releases/[releases] page: >>> + >>> +http://wpan.cakelab.org/releases/ >>> + >>> +Supported Hardware >>> +------------------ >>> + >>> +.Supported 802.15.4 Hardware >>> +[cols="3,4,2,^2,12",options="header"] >>> +|============================================================= >>> +|Transceiver |Supported |Driver | Bus |Where to buy >>> +|at86rf230 |no |at86rf230? | SPI | >>> +|at86rf231 |yes |at86rf230 | SPI | >>> http://downloads.qi-hardware.com/people/werner/wpan/web/[atben] Out of >>> stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact >>> http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. >>> +|at86rf233 |yes |at86rf230 | SPI | >>> http://openlabs.co/store/Raspberry-Pi-802.15.4-radio[openlabs] >>> +|at86rf212 |yes |at86rf230 | SPI | >>> +|atusb |not mainline yet |atusb | USB | >>> http://downloads.qi-hardware.com/people/werner/wpan/web/[atusb] Out of >>> stock. Mailto linux-wpan and Werner to produce maybe new ones. Or contact >>> http://en.qi-hardware.com/wiki/Main_Page[qi-hardware]. >>> +|============================================================= >> Maybe mention the other drivers we have mainline here as well? CC2520 and >> MRF24j40 are fully supported or not? > Don't know about these transceivers I have CC2520 here but these are > buildin inside some contiki nodes and I don't have any pinout headers > for these. > > Specially MRF24j40 have some different types and I don't know which type > is now supported. The driver maintainers can send patches to linux-wpan > and I will apply changes to wpan-misc and generate a new website. This sounds fair to me. People using the driver can better comment on this. > For futher maybe we should add some "features" collumn because many of > them doesn't support all driver callbacks. I think this is a good idea. regards Stefan Schmidt ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH wpan-misc] website: inital commit 2014-12-12 13:47 ` [PATCH wpan-misc] website: inital commit Alexander Aring 2014-12-12 14:03 ` Stefan Schmidt @ 2014-12-12 14:08 ` Stefan Schmidt 2014-12-12 14:15 ` Alexander Aring 1 sibling, 1 reply; 7+ messages in thread From: Stefan Schmidt @ 2014-12-12 14:08 UTC (permalink / raw) To: Alexander Aring, linux-wpan Hello. On 12/12/14 14:47, Alexander Aring wrote: > +Rework > +~~~~~~ > + > +Currently a rework of 802.15.4 subsystem is in progress. > + > +The rework will contains a new netlink API and a general handling about frame creation and parsing. > + > +.Supported 802.15.4 Hardware Better give this table a different name. :) > +[options="header"] > +|======================================= > +|Milestone | Description | state > +|1. nl802154 | new netlink framework | [green]#mostly done# > +|2. crypto-layer | accessable over nl802154 and tools | [red]#TODO# > +|3. frame parsing | remove bugs, more generical | [red]#TODO# > +|======================================= > + > +For the nl802154 framework you will need the wpan-tools, older kernels need lowpan-tools but this is not recommended. > + > +// vim: set syntax=asciidoc: regards Stefan Schmidt ^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: [PATCH wpan-misc] website: inital commit 2014-12-12 14:08 ` Stefan Schmidt @ 2014-12-12 14:15 ` Alexander Aring 0 siblings, 0 replies; 7+ messages in thread From: Alexander Aring @ 2014-12-12 14:15 UTC (permalink / raw) To: Stefan Schmidt; +Cc: linux-wpan On Fri, Dec 12, 2014 at 03:08:21PM +0100, Stefan Schmidt wrote: > Hello. > > On 12/12/14 14:47, Alexander Aring wrote: > > +Rework > > +~~~~~~ > > + > > +Currently a rework of 802.15.4 subsystem is in progress. > > + > > +The rework will contains a new netlink API and a general handling about frame creation and parsing. > > + > > +.Supported 802.15.4 Hardware > > Better give this table a different name. :) > ok, I will fix that in the next series. Thanks. - Alex ^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2014-12-12 14:34 UTC | newest] Thread overview: 7+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2014-12-12 13:47 [PATCH wpan-misc] website: introduce asciidoc website generation framework Alexander Aring 2014-12-12 13:47 ` [PATCH wpan-misc] website: inital commit Alexander Aring 2014-12-12 14:03 ` Stefan Schmidt 2014-12-12 14:20 ` Alexander Aring 2014-12-12 14:34 ` Stefan Schmidt 2014-12-12 14:08 ` Stefan Schmidt 2014-12-12 14:15 ` Alexander Aring
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).