Bug 154589

Summary: ath_hal(4) manpage lists incorrect Netgear adapter as supported
Product: Documentation Reporter: Jason Mann <jason.mann>
Component: Books & ArticlesAssignee: Josh Paetzel <jpaetzel>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Jason Mann 2011-02-08 13:30:12 UTC
NetGear have produced both a WG311 and a WG311T PCI wireless adapter.  The latter is based on an Atheros AR5212 chip while the former is not.

The ath_hal(4) man page incorrectly lists the NetGear WG311 adapter as being supported by the ath_hal driver, whereas it is the WG311T that should be listed.

Fix: 

Correct the man page by appending 'T' to the NetGear WG311 adapter model name.
How-To-Repeat: n/a
Comment 1 Josh Paetzel freebsd_committer freebsd_triage 2011-02-09 15:07:23 UTC
There are three versions of the WG311 now, all using different chipsets.  At 
the time the manpage was written, there was only one version of the WG311, and 
it does in fact use an atheros chipset.  Today it is called the WG311v1, and 
is works with ath.  I believe the v2 is also an atheros and also works with 
ath.  The v3 is definitely not an atheros though, and isn't supported.  The v3 
is also what you can buy these days.

The man page is somewhat like a book written about World War One in 1924.

Many of the wireless man pages are in the same shape as this one.  The same 
product can be based on several chipsets throughout it's lifespan, and 
oftentimes the man pages reflect the situation that existed when they were 
written or updated, not the situation as it exists today.

I'd recommend listing the WG311v1 as supported as well as the WG311T, since we 
know for sure these work.  Perhaps someone with a v2 and v3 can provide input 
as to their status.

-- 
Thanks,

Josh Paetzel
FreeBSD -- The power to serve
Comment 2 Jason Mann 2011-02-09 17:27:54 UTC
Hi Josh,

I can say with certainty that the WG311v3 isn't supported by ath_hal
as it was discovering this fact last week that prompted me to
substitute it for a WG311T and submit this PR.

The WG311v3 adapter actually requires if_malo.ko and is listed in that
driver's man page.

Here's my relevant dmesg lines for the WG311T:

ath0: <Atheros 5212> mem 0xec000000-0xec00ffff irq 17 at device 10.0 on pci=
0
ath0: [ITHREAD]
ath0: AR2413 mac 7.9 RF2413 phy 4.5


Regards,

Jason


On 9 February 2011 15:07, Josh Paetzel <jpaetzel@freebsd.org> wrote:
> There are three versions of the WG311 now, all using different chipsets. =
=A0At
> the time the manpage was written, there was only one version of the WG311=
, and
> it does in fact use an atheros chipset. =A0Today it is called the WG311v1=
, and
> is works with ath. =A0I believe the v2 is also an atheros and also works =
with
> ath. =A0The v3 is definitely not an atheros though, and isn't supported. =
=A0The v3
> is also what you can buy these days.
>
> The man page is somewhat like a book written about World War One in 1924.
>
> Many of the wireless man pages are in the same shape as this one. =A0The =
same
> product can be based on several chipsets throughout it's lifespan, and
> oftentimes the man pages reflect the situation that existed when they wer=
e
> written or updated, not the situation as it exists today.
>
> I'd recommend listing the WG311v1 as supported as well as the WG311T, sin=
ce we
> know for sure these work. =A0Perhaps someone with a v2 and v3 can provide=
 input
> as to their status.
>
> --
> Thanks,
>
> Josh Paetzel
> FreeBSD -- The power to serve
>
Comment 3 Josh Paetzel freebsd_committer freebsd_triage 2011-02-10 00:06:26 UTC
Responsible Changed
From-To: freebsd-doc->jpaetzel

I'll take it
Comment 4 dfilter service freebsd_committer freebsd_triage 2011-02-10 15:41:39 UTC
Author: jpaetzel
Date: Thu Feb 10 15:41:32 2011
New Revision: 218523
URL: http://svn.freebsd.org/changeset/base/218523

Log:
  Netgear renamed the WG311 to the WG311v1 after they released a second
  version of it.  There is also a WG311v3 which uses a chipset covered by
  malo(4). Along the way add the WG311T to the list which is also an
  atheros chipset.
  
  PR:	docs/154589
  Approved by:	kib (mentor)
  MFC after:	3 days

Modified:
  head/share/man/man4/ath_hal.4

Modified: head/share/man/man4/ath_hal.4
==============================================================================
--- head/share/man/man4/ath_hal.4	Thu Feb 10 15:07:17 2011	(r218522)
+++ head/share/man/man4/ath_hal.4	Thu Feb 10 15:41:32 2011	(r218523)
@@ -109,7 +109,9 @@ module:
 .It "Netgear WAG311	AR5212	PCI	a/b/g"
 .It "Netgear WAB501	AR5211	CardBus	a/b"
 .It "Netgear WAG511	AR5212	CardBus	a/b/g"
-.It "Netgear WG311	AR5212	PCI	b/g"
+.It "Netgear WG311 (aka WG311v1)	AR5212	PCI	b/g"
+.It "Netgear WG311v2	AR5212	PCI	b/g"
+.It "Netgear WG311T	AR5212	PCI	b/g"
 .It "Netgear WG511T	AR5212	CardBus	b/g"
 .It "Orinoco 8480	AR5212	CardBus	a/b/g"
 .It "Orinoco 8470WD	AR5212	CardBus	a/b/g"
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
Comment 5 Josh Paetzel freebsd_committer freebsd_triage 2011-02-10 15:41:54 UTC
State Changed
From-To: open->closed

Committed, thanks.