Changeset 8330


Ignore:
Timestamp:
2007-08-03T11:31:47+02:00 (9 years ago)
Author:
florian
Message:

Add some more documentation

Location:
trunk/docs
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/Makefile

    r7905 r8330  
    3333        rm -f *.log *.aux *.toc *.out *.lg *.dvi *.idv *.4ct *.4tc *.xref *.tmp *.dvi 
    3434 
     35$(eval $(call RequireCommand,latex, \ 
     36        You need to install LaTeX to build the OpenWrt documentation \ 
     37)) 
    3538$(eval $(call RequireCommand,pdflatex, \ 
    3639        You need to install LaTeX to build the OpenWrt documentation \ 
  • trunk/docs/network.tex

    r6502 r8330  
    103103On Broadcom hardware the CPU port is always 5. The other ports may vary with 
    104104different hardware. 
     105 
     106For instance, if you wish to have 3 vlans, like one 3-port switch, 1 port in a 
     107DMZ, and another one as your WAN interface, use the following configuration : 
     108 
     109\begin{Verbatim} 
     110config switch       "eth0" 
     111    option vlan0    "1 2 3 5*" 
     112    option vlan1    "0 5" 
     113    option vlan2    "4 5" 
     114\end{Verbatim} 
  • trunk/docs/wireless.tex

    r8296 r8330  
    33it should detect your card and create a sample configuration file. By default '\texttt{option network  lan}' is 
    44commented. This prevents unsecured sharing of the network over the wireless interface. 
     5 
     6Each wireless driver has its own configuration script in \texttt{/lib/wifi/driver\_name.sh} which handles 
     7driver specific options and configurations. This script is also calling driver specific binaries like wlc for 
     8Broadcom, or hostapd and wpa\_supplicant for atheros. 
     9 
     10The reason for using such architecture, is that it abstracts the driver configuration  
    511 
    612\paragraph{Generic Broadcom wireless config:} 
     
    211217        \end{itemize} 
    212218\end{itemize} 
     219 
     220\paragraph{Adding a new driver configuration} 
     221 
     222Since we currently only support two different wireless drivers : Broadcom and Atheros, 
     223you might be interested in adding support for another driver like Ralink RT2x00,  
     224Texas Instruments ACX100/111. 
     225 
     226The driver specific script should be placed in \texttt{/lib/wifi/<driver>.sh} and has to 
     227include several functions providing : 
     228 
     229\begin{itemize} 
     230        \item detection of the driver presence 
     231        \item enabling/disabling the wifi interface(s) 
     232        \item configuration reading and setting 
     233        \item third-party programs calling (nas, supplicant) 
     234\end{itemize} 
     235 
     236Each driver script should append the driver to a global DRIVERS variable : 
     237 
     238\begin{verbatim} 
     239append DRIVERS "driver name" 
     240\end{verbatim} 
     241 
     242\subparagraph{scan\_driver} 
     243 
     244This function will parse the \texttt{/etc/config/wireless} and make sure there 
     245are no configuration incompatibilities, like enabling hidden SSIDS with ad-hoc mode 
     246for instance. This can be more complex if your driver supports a lof of configuration 
     247options. It does not enable your wireless driver to work. 
     248 
     249\subparagraph{enable\_driver} 
     250 
     251This function will enable the driver and read the configuration file to create application 
     252specific configuration files for the NAS or supplicant program. It will not check the 
     253configuration consistency. 
     254 
     255\subparagraph{disable\_driver} 
     256 
     257This function should properly shutdown the wireless interfaces and kill associated programs 
     258running on top of it. 
     259 
     260\subparagraph{detec\_driver} 
     261 
     262This function should reliably report the existence of the driver and of one or more of its 
     263wireless interfaces. A basic configuration file has to be generated in the meantime. 
     264 
Note: See TracChangeset for help on using the changeset viewer.