Added file templates to doc
This commit is contained in:
parent
683aed1f3f
commit
70a4ba58b4
141
doc/format.hfile
Normal file
141
doc/format.hfile
Normal file
|
@ -0,0 +1,141 @@
|
|||
/* aheader.h: [one line description of the file]
|
||||
* --------------------------------------------------------------------
|
||||
*
|
||||
* [Project Name]
|
||||
*
|
||||
* [License Statement, eg.
|
||||
* The contents of this file are subject to the Mozilla Public
|
||||
* License Version 1.0 (the "License"); you may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of
|
||||
* the License at http://www.mozilla.org/MPL/ ]
|
||||
*
|
||||
* [Warranty Statement, eg.
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License. ]
|
||||
*
|
||||
* [Author contact, eg.
|
||||
* The initial developer of the original code is Mark S. Mathews
|
||||
* < mark@absoval.com >. Portions created by Mark S. Mathews
|
||||
* are Copyright (C) 1998 AbsoluteValue Software, Inc. All
|
||||
* Rights Reserved. ]
|
||||
*
|
||||
* [Change History]
|
||||
*
|
||||
* [Verbose Description]
|
||||
*
|
||||
* [Implementation and usage notes]
|
||||
*
|
||||
* [References]
|
||||
*
|
||||
* --------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
#ifndef _AHEADER_H
|
||||
#define _AHEADER_H
|
||||
|
||||
/*=============================================================*/
|
||||
/*------ Constants --------------------------------------------*/
|
||||
|
||||
/*--- Fixed memory offsets --------------------------*/
|
||||
#define SU_OFF_LAST_TXDESC 0x3ec
|
||||
#define SU_OFF_RSVD1 0x400
|
||||
#define SU_OFF_BANNER 0x480
|
||||
#define SU_OFF_CMD_BLK 0x4a0
|
||||
#define SU_OFF_CNTL_STATUS_BLK 0x4f0
|
||||
#define SU_OFF_VBM 0x500
|
||||
#define SU_OFF_BUFFER 0x600
|
||||
|
||||
/*--- Global Sizes ----------------------------------*/
|
||||
#define SU_LEN_BANNER 32
|
||||
|
||||
|
||||
|
||||
/*=============================================================*/
|
||||
/*------ Macros -----------------------------------------------*/
|
||||
|
||||
/*--- next testing macro (applies to Rx and Tx) -------*/
|
||||
#define SUTXD_ISLAST(x) ((x) & BIT31)
|
||||
#define SURXD_ISLAST(x) ((x) & BIT31)
|
||||
|
||||
|
||||
/*=============================================================*/
|
||||
/*------ Types and their related constants --------------------*/
|
||||
|
||||
/*--- Last Completed Tx Descriptor Block ---------------*/
|
||||
__WLAN_PRAGMA_PACK1__
|
||||
typedef struct am930txcmplt_blk
|
||||
{
|
||||
volatile UINT32 last_bcast __WLAN_ATTRIB_PACK__;
|
||||
volatile UINT32 last_mgmt __WLAN_ATTRIB_PACK__;
|
||||
volatile UINT32 last_data __WLAN_ATTRIB_PACK__;
|
||||
volatile UINT32 last_pspoll __WLAN_ATTRIB_PACK__;
|
||||
volatile UINT32 last_cfpoll __WLAN_ATTRIB_PACK__;
|
||||
} am930txcmplt_blk_t;
|
||||
__WLAN_PRAGMA_PACKDFLT__
|
||||
|
||||
#define TXCMPLT_OFF_BCAST 0
|
||||
#define TXCMPLT_OFF_MGMT 4
|
||||
#define TXCMPLT_OFF_DATA 8
|
||||
#define TXCMPLT_OFF_PSPOLL 12
|
||||
#define TXCMPLT_OFF_CFPOLL 16
|
||||
|
||||
typedef void (*am930hw_scan_callback_t)(void *);
|
||||
|
||||
/*=============================================================*/
|
||||
/*--- Function Declarations -----------------------------------*/
|
||||
/*=============================================================*/
|
||||
/* public: */
|
||||
am930hw_t*
|
||||
am930hw_construct(UINT32 irq, UINT32 iobase,
|
||||
UINT32 membase, am930mac_t *mac);
|
||||
|
||||
void
|
||||
am930hw_destruct(am930hw_t *hw);
|
||||
|
||||
int
|
||||
am930hw_init_rx_tx( am930hw_t *hw );
|
||||
|
||||
void
|
||||
am930hw_ISR( am930hw_t *hw );
|
||||
|
||||
UINT32
|
||||
am930hw_joinbss( am930hw_t *hw, UINT32 ch, UINT32 newBSS,
|
||||
UINT8 *bssid, wlan_ie_ssid_t *ssid, UINT32 bcn_int,
|
||||
wlan_bss_ts_t ts, UINT32 sutro_ref_time );
|
||||
|
||||
UINT32
|
||||
am930hw_scan( am930hw_t *hw, UINT32 cntl, UINT8 *bssid,
|
||||
UINT32 ch, UINT32 duration,
|
||||
am930hw_scan_callback_t cb, void *callback_arg );
|
||||
|
||||
UINT32
|
||||
am930hw_reset( am930hw_t *hw );
|
||||
|
||||
/*=============================================================*/
|
||||
/*--- Inline Function Definitions (if supported) --------------*/
|
||||
/*=============================================================*/
|
||||
|
||||
/*----------------------------------------------------------------
|
||||
* am930hw_reset
|
||||
*
|
||||
* Perform reset of am930 part and test for valid operation
|
||||
* operation following reset.
|
||||
*
|
||||
* returns: zero on success, non-zero if part fails to come up
|
||||
* after reset.
|
||||
----------------------------------------------------------------*/
|
||||
__INLINE__ UINT32 am930hw_reset( am930hw_t* hw)
|
||||
{
|
||||
UINT32 result = 0;
|
||||
|
||||
/* perform reset */
|
||||
/* test part */
|
||||
return result;
|
||||
}
|
||||
|
||||
#endif /* _AHEADER_H */
|
||||
</PRE></TD>
|
||||
</TABLE>
|
||||
|
126
doc/format.srcfile
Normal file
126
doc/format.srcfile
Normal file
|
@ -0,0 +1,126 @@
|
|||
<TABLE border=1>
|
||||
<TR><TD><PRE>
|
||||
/* asource.c: [one line description of file]
|
||||
* --------------------------------------------------------------------
|
||||
*
|
||||
* [Project Name]
|
||||
*
|
||||
* [License Statement, eg.
|
||||
* The contents of this file are subject to the Mozilla Public
|
||||
* License Version 1.0 (the "License"); you may not use this file
|
||||
* except in compliance with the License. You may obtain a copy of
|
||||
* the License at http://www.mozilla.org/MPL/ ]
|
||||
*
|
||||
* [Warranty Statement, eg.
|
||||
* Software distributed under the License is distributed on an "AS
|
||||
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
||||
* implied. See the License for the specific language governing
|
||||
* rights and limitations under the License. ]
|
||||
*
|
||||
* [Author contact, eg.
|
||||
* The initial developer of the original code is Mark S. Mathews
|
||||
* < mark@absoval.com >. Portions created by Mark S. Mathews
|
||||
* are Copyright (C) 1998 AbsoluteValue Software, Inc. All
|
||||
* Rights Reserved. ]
|
||||
*
|
||||
* [Change History]
|
||||
*
|
||||
* [Verbose Description]
|
||||
*
|
||||
* [Implementation and usage notes]
|
||||
*
|
||||
* [References]
|
||||
*
|
||||
* --------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
/* Portability/Compatibility header */
|
||||
#include <wlan/wlan_compat.h>
|
||||
|
||||
/* The following prevents "kernel_version" from being set in this file. */
|
||||
#define __NO_VERSION__
|
||||
|
||||
/* Non-project specific includes */
|
||||
/* PCMCIA headers generated during PCMCIA package installation */
|
||||
#include <pcmcia/config.h>
|
||||
#include <pcmcia/k_compat.h>
|
||||
|
||||
/* Module related headers, non-module drivers should not include */
|
||||
#include <linux/version.h>
|
||||
|
||||
#include <assert.h>
|
||||
#include <linux/delay.h>
|
||||
#include <linux/kernel.h>
|
||||
#include <linux/types.h>
|
||||
#include <linux/fcntl.h>
|
||||
#include <linux/interrupt.h>
|
||||
#include <linux/ptrace.h>
|
||||
#include <linux/ioport.h>
|
||||
#include <linux/in.h>
|
||||
#include <linux/malloc.h>
|
||||
#include <linux/string.h>
|
||||
#include <linux/timer.h>
|
||||
#include <asm/system.h>
|
||||
#include <asm/bitops.h>
|
||||
#include <asm/io.h>
|
||||
#include <linux/errno.h>
|
||||
|
||||
/* Project Includes */
|
||||
#include <wlan/version.h>
|
||||
#include <wlan/am930mib.h>
|
||||
#include <wlan/p80211hdr.h>
|
||||
#include <wlan/p80211mgmt.h>
|
||||
#include <wlan/wlan_ioctl.h>
|
||||
#include <wlan/wlan_stable.h>
|
||||
#include "am930di.h"
|
||||
#include "am930llc.h"
|
||||
#include "am930mac.h"
|
||||
#include "am930hw.h"
|
||||
#include "am930mgr.h"
|
||||
|
||||
/*================================================================*/
|
||||
/* Local Constants */
|
||||
|
||||
#define ACONSTANT 22
|
||||
|
||||
|
||||
/*================================================================*/
|
||||
/* Local Types */
|
||||
|
||||
typdef struct atype
|
||||
{
|
||||
struct atype *next;
|
||||
struct atype *prev;
|
||||
} atype_t;
|
||||
|
||||
|
||||
/*================================================================*/
|
||||
/* Statics defined in this file */
|
||||
|
||||
UINT8 wepkey[WLAN_WEP_NKEYS][WLAN_WEP_KEYLEN] =
|
||||
{
|
||||
{ 0xf1, 0x10, 0xec, 0xe0, 0xdc },
|
||||
{ 0x0f, 0xf2, 0x04, 0x09, 0xfb },
|
||||
{ 0x13, 0x37, 0xf2, 0xf9, 0x2d },
|
||||
{ 0xe9, 0x17, 0x19, 0x63, 0xc7 }
|
||||
};
|
||||
|
||||
|
||||
/*================================================================*/
|
||||
/* Local Functions Declarations */
|
||||
|
||||
static void am930mgr_authen1_rx( am930mgr_t *mgr, wlan_fr_authen_t *f );
|
||||
static void am930mgr_authen2_rx( am930mgr_t *mgr, wlan_fr_authen_t *f );
|
||||
static void am930mgr_authen3_rx( am930mgr_t *mgr, wlan_fr_authen_t *f );
|
||||
static void am930mgr_authen4_rx( am930mgr_t *mgr, wlan_fr_authen_t *f );
|
||||
|
||||
|
||||
/*----------------------------------------------------------------
|
||||
* am930mgr_assoc_begin_sta
|
||||
*
|
||||
* Start the station association procedure. Namely, send an
|
||||
* association request frame to the AP.
|
||||
*
|
||||
* returns: nothing for now
|
||||
----------------------------------------------------------------*/
|
||||
void am930mgr_assoc_begin_sta(am930mgr_t *mgr)
|
Loading…
Reference in a new issue