From rea-fbsd@codelabs.ru  Fri Mar 16 07:09:24 2007
Return-Path: <rea-fbsd@codelabs.ru>
Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id D53D416A402
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 16 Mar 2007 07:09:24 +0000 (UTC)
	(envelope-from rea-fbsd@codelabs.ru)
Received: from pobox.codelabs.ru (pobox.codelabs.ru [144.206.177.45])
	by mx1.freebsd.org (Postfix) with ESMTP id 9239D13C45E
	for <FreeBSD-gnats-submit@freebsd.org>; Fri, 16 Mar 2007 07:09:24 +0000 (UTC)
	(envelope-from rea-fbsd@codelabs.ru)
Received: from localdomain
	by pobox.codelabs.ru with local
	id 1HS6Yw-0007lJ-MQ; Fri, 16 Mar 2007 10:09:18 +0300
Message-Id: <E1HS6Yw-0007lJ-MQ@pobox.codelabs.ru>
Date: Fri, 16 Mar 2007 10:09:18 +0300
From: Eygene Ryabinkin <rea-fbsd@codelabs.ru>
Sender: rea-fbsd@codelabs.ru
Reply-To: Eygene Ryabinkin <rea-fbsd@codelabs.ru>
To: FreeBSD-gnats-submit@freebsd.org
Cc: flz@freebsd.org
Subject: add some more explanations for the iwi/ipw firmware inclusion
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         110376
>Category:       docs
>Synopsis:       [patch] add some more explanations for the iwi/ipw firmware inclusion
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Fri Mar 16 07:10:06 GMT 2007
>Closed-Date:    
>Last-Modified:  Sun Jan  3 22:50:02 UTC 2010
>Originator:     Eygene Ryabinkin
>Release:        FreeBSD 7.0-CURRENT i386
>Organization:
Code Labs
>Environment:
System: FreeBSD XXX 7.0-CURRENT FreeBSD 7.0-CURRENT #7: Tue Mar 13 16:56:09 MSK 2007 root@XXX:/usr/obj/usr/src/sys/XXX i386
>Description:
The inclusion of iwi/ipw firmware into the base system was a great
step. But the UPDATING and the iwi/ipw manual pages are saying
nothing about the need of inclusion of the iwifw/ipwfw modules
into the kernel configuration. And some people are building just
the restricted set of kernel modules, so they should know what they
will need to add to enable the system's firmware modules to be
built and installed into a proper place.

Also, manual pages iwi(4) and ipw(4) are specifying that the
license kenv tunable is license.intel_<name>.license_ack. Reading
the /sys/tools/fw_stub.awk I had a strong feeling that the right
name is license.<name>.license_ack as noted in the original commit
message and in the UPDATING.
>How-To-Repeat:
Look into the UPDATING and iwi/ipw manual pages: they are telling
nothing about the need of iwifw/ipwfw kernel modules. And the man
pages are telling about license.intel_{iwi,ipw}.license_ack.
>Fix:
The following patches will do the trick.

--- UPDATING.orig	Fri Mar 16 09:39:23 2007
+++ UPDATING	Fri Mar 16 10:04:48 2007
@@ -25,7 +25,8 @@
 	Firmwares for ipw(4) and iwi(4) are now included in the base tree.
 	In order to use them one must agree to the respective LICENSE in
 	share/doc/legal and define legal.<name>.license_ack=1 via
-	loader.conf(5) or kenv(1).
+	loader.conf(5) or kenv(1). Kernel module(s) <name>fw should be
+	built and installed to get the actual firmware.
 
 20070228:
 	The name resolution/mapping functions addr2ascii(3) and ascii2addr(3)

--- iwi.4.orig	Fri Mar 16 09:48:05 2007
+++ iwi.4	Fri Mar 16 10:03:39 2007
@@ -75,12 +75,15 @@
 .Xr ifconfig 8 .
 .Pp
 This driver requires firmware to be loaded before it will work.
+The firmware is installed by the kernel module
+.Nm iwifw .
+.Pp
 For the loaded firmware to work the license at
 .Pa /usr/share/doc/legal/intel_iwi/LICENSE
 must be agreed to and the following line be added to
 .Xr loader.conf 5 :
 .Pp
-.Dl "legal.intel_iwi.license_ack=1"
+.Dl "legal.iwi.license_ack=1"
 .Sh FILES
 .Bl -tag -width ".Pa /usr/share/doc/legal/intel_iwi/LICENSE" -compact
 .It Pa /usr/share/doc/legal/intel_iwi/LICENSE

--- ipw.4.orig	Fri Mar 16 09:57:56 2007
+++ ipw.4	Fri Mar 16 10:03:15 2007
@@ -75,12 +75,15 @@
 .Xr ifconfig 8 .
 .Pp
 This driver requires firmware to be loaded before it will work.
+The firmware is installed by the kernel module
+.Nm iwifw .
+.Pp
 For the loaded firmware to work the license at
 .Pa /usr/share/doc/legal/intel_ipw/LICENSE
 must be agreed to and the following line be added to
 .Xr loader.conf 5 :
 .Pp
-.Dl "legal.intel_ipw.license_ack=1"
+.Dl "legal.ipw.license_ack=1"
 .Sh FILES
 .Bl -tag -width ".Pa /usr/share/doc/legal/intel_ipw/LICENSE" -compact
 .It Pa /usr/share/doc/legal/intel_ipw/LICENSE
>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-bugs->freebsd-doc 
Responsible-Changed-By: linimon 
Responsible-Changed-When: Fri Mar 16 07:58:36 UTC 2007 
Responsible-Changed-Why:  
Reclassify. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=110376 

From: Szilveszter Adam <sziszi@bsd.hu>
To: FreeBSD-gnats-submit@freebsd.org
Cc:  
Subject: Re: kern/110376: add some more explanations for the iwi/ipw
	firmware inclusion
Date: Fri, 16 Mar 2007 10:21:21 +0100

 Hello,
 
 On Fri, Mar 16, 2007 at 10:09:18AM +0300, Eygene Ryabinkin wrote:
 > Also, manual pages iwi(4) and ipw(4) are specifying that the
 > license kenv tunable is license.intel_<name>.license_ack. Reading
 > the /sys/tools/fw_stub.awk I had a strong feeling that the right
 > name is license.<name>.license_ack as noted in the original commit
 > message and in the UPDATING.
 
 Well, I also had this feeling at first (especially since I tend to trust
 UPDATING in these matters) but it is not so. I know this because I have
 tried the variant you suggested first and found out fairly quickly that
 the firmware did not load. :-) This was on iwi, btw, but I do not think
 this matters. With the variant in the man page, it works 1A. I specify
 the var in /boot/loader.conf. And the var name starts with "legal" not
 "license" in both cases.
 
 Your first point about required kernel modules stands however :-)
 
 -- 
 Regards:
 
 Szilveszter ADAM
 Budapest
 Hungary

From: Warren Block <wblock@wonkity.com>
To: bug-followup@FreeBSD.org, rea-fbsd@codelabs.ru
Cc:  
Subject: Re: docs/110376: [patch] add some more explanations for the iwi/ipw
 firmware inclusion
Date: Sun, 3 Jan 2010 15:47:52 -0700 (MST)

 ipw and iwi now use firmware(9) and so references to ifwfw(4) are 
 obsolete:
 
    "This driver requires the firmware built with the ipwfw module to
     work."
 
 This sentence can be eliminated.
 
    "For the loaded firmware to be enabled for use the license at"
 
 Should probably be changed to
 
    "For the IBM firmware to be enabled for use the license at"
 
 Also, the references to ipwfw(4) in the SEE ALSO section should be 
 removed.
 
 -Warren Block * Rapid City, South Dakota USA
>Unformatted:
