168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 2543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * FILE : HCF.C 4543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 5543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DATE : $Date: 2004/08/05 11:47:10 $ $Revision: 1.10 $ 6543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/06/02 10:22:22 Revision: 1.85 Tag: hcf7_t20040602_01 7543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/04/15 09:24:41 Revision: 1.63 Tag: hcf7_t7_20040415_01 8543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/04/13 14:22:44 Revision: 1.62 Tag: t7_20040413_01 9543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/04/01 15:32:55 Revision: 1.59 Tag: t7_20040401_01 10543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/03/10 15:39:27 Revision: 1.55 Tag: t20040310_01 11543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/03/04 11:03:37 Revision: 1.53 Tag: t20040304_01 12543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/03/02 14:51:21 Revision: 1.50 Tag: t20040302_03 13543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/02/24 13:00:27 Revision: 1.43 Tag: t20040224_01 14543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Original: 2004/02/19 10:57:25 Revision: 1.39 Tag: t20040219_01 15543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 16543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * AUTHOR : Nico Valster 17543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 18543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * SPECIFICATION: ........ 19543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 20543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DESCRIPTION : HCF Routines for Hermes-II (callable via the Wireless Connection I/F or WCI) 21543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Local Support Routines for above procedures 22543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 23543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Customizable via HCFCFG.H, which is included by HCF.H 24543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 25543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************* 26543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 27543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 28543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * SOFTWARE LICENSE 29543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 30543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This software is provided subject to the following terms and conditions, 31543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * which you should read carefully before using the software. Using this 32543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * software indicates your acceptance of these terms and conditions. If you do 33543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * not agree with these terms and conditions, do not use the software. 34543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 35d36b691077dc59c74efec0d54ed21b86f7a2a21aAl Viro * COPYRIGHT © 1994 - 1995 by AT&T. All Rights Reserved 36d36b691077dc59c74efec0d54ed21b86f7a2a21aAl Viro * COPYRIGHT © 1996 - 2000 by Lucent Technologies. All Rights Reserved 37d36b691077dc59c74efec0d54ed21b86f7a2a21aAl Viro * COPYRIGHT © 2001 - 2004 by Agere Systems Inc. All Rights Reserved 38543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * All rights reserved. 39543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 40543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Redistribution and use in source or binary forms, with or without 41543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * modifications, are permitted provided that the following conditions are met: 42543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 43543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * . Redistributions of source code must retain the above copyright notice, this 44543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * list of conditions and the following Disclaimer as comments in the code as 45543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * well as in the documentation and/or other materials provided with the 46543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * distribution. 47543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 48543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * . Redistributions in binary form must reproduce the above copyright notice, 49543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * this list of conditions and the following Disclaimer in the documentation 50543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and/or other materials provided with the distribution. 51543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 52543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * . Neither the name of Agere Systems Inc. nor the names of the contributors 53543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * may be used to endorse or promote products derived from this software 54543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * without specific prior written permission. 55543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 56543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Disclaimer 57543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 58543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 59543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF 60543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ANY 61543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN 62543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY 63543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 64543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 65543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 66543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT 67543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 68543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 69543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DAMAGE. 70543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 71543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 72543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 7368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 7468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 7568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 76543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ** 77543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ** Implementation Notes 78543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ** 79543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a leading marker of //! is used. The purpose of such a sequence is to help to understand the flow 80543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * An example is: //!rc = HCF_SUCCESS; 81543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * if this is superfluous because rc is already guaranteed to be 0 but it shows to the (maintenance) 82543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * programmer it is an intentional omission at the place where someone could consider it most appropriate at 83543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * first glance 84543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - using near pointers in a model where ss!=ds is an invitation for disaster, so be aware of how you specify 85543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * your model and how you define variables which are used at interrupt time 86543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - remember that sign extension on 32 bit platforms may cause problems unless code is carefully constructed, 87543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * e.g. use "(hcf_16)~foo" rather than "~foo" 88543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 89543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 9068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 91543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#include "hcf.h" // HCF and MSF common include file 92543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#include "hcfdef.h" // HCF specific include file 93543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#include "mmd.h" // MoreModularDriver common include file 9450af5ead3b44ccf8bd2b4d2a50c1b610f557c480Paul Gortmaker#include <linux/bug.h> 95a252d02f89452c1d99eed7545457f52a71804768Andy Shevchenko#include <linux/kernel.h> 9668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 9768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ! defined offsetof 9868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define offsetof(s,m) ((unsigned int)&(((s *)0)->m)) 9968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // offsetof 10068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 10168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 10268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/***********************************************************************************************************/ 10368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/*************************************** PROTOTYPES ******************************************************/ 10468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/***********************************************************************************************************/ 105543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int cmd_exe( IFBP ifbp, hcf_16 cmd_code, hcf_16 par_0 ); 106543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int init( IFBP ifbp ); 107543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int put_info( IFBP ifbp, LTVP ltvp ); 108543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int put_info_mb( IFBP ifbp, CFG_MB_INFO_STRCT FAR * ltvp ); 10968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 110543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void calc_mic( hcf_32* p, hcf_32 M ); 111543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid calc_mic_rx_frag( IFBP ifbp, wci_bufp p, int len ); 112543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid calc_mic_tx_frag( IFBP ifbp, wci_bufp p, int len ); 113543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int check_mic( IFBP ifbp ); 11468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 11568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 116543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void calibrate( IFBP ifbp ); 117543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int cmd_cmpl( IFBP ifbp ); 118543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC hcf_16 get_fid( IFBP ifbp ); 119543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void isr_info( IFBP ifbp ); 12068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 121543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC DESC_STRCT* get_frame_lst(IFBP ifbp, int tx_rx_flag); 12268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 123543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void get_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ); //char*, byte count (usually even) 12468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 125543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void put_frame_lst( IFBP ifbp, DESC_STRCT *descp, int tx_rx_flag ); 12668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 127543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void put_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ); 128543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC void put_frag_finalize( IFBP ifbp ); 129543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int setup_bap( IFBP ifbp, hcf_16 fid, int offset, int type ); 13068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_PRINTF 13168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstatic int fw_printf(IFBP ifbp, CFG_FW_PRINTF_STRCT FAR *ltvp); 13268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_PRINTF 13368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 134543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC int download( IFBP ifbp, CFG_PROG_STRCT FAR *ltvp ); 135543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC hcf_8 hcf_encap( wci_bufp type ); 136543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC hcf_8 null_addr[4] = { 0, 0, 0, 0 }; 137543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if ! defined IN_PORT_WORD //replace I/O Macros with logging facility 13868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootextern FILE *log_file; 13968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 140543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#define IN_PORT_WORD(port) in_port_word( (hcf_io)(port) ) 14168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 14268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstatic hcf_16 in_port_word( hcf_io port ) { 143543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i = (hcf_16)_inpw( port ); 14468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 14568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nR %2.2x %4.4x", (port)&0xFF, i); 14668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 14768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return i; 14868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // in_port_word 14968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 150543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#define OUT_PORT_WORD(port, value) out_port_word( (hcf_io)(port), (hcf_16)(value) ) 15168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 15268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstatic void out_port_word( hcf_io port, hcf_16 value ) { 15368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot _outpw( port, value ); 15468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 15568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nW %2.02x %4.04x", (port)&0xFF, value ); 15668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 15768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} 15868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 159543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid IN_PORT_STRING_32( hcf_io prt, hcf_32 FAR * dst, int n) { 16068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot int i = 0; 16168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_16 FAR * p; 16268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 16368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nread string_32 length %04x (%04d) at port %02.2x to addr %lp", 164543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (hcf_16)n, (hcf_16)n, (hcf_16)(prt)&0xFF, dst); 16568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 16668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( n-- ) { 16768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = (hcf_16 FAR *)dst; 16868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *p++ = (hcf_16)_inpw( prt ); 16968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *p = (hcf_16)_inpw( prt ); 17068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 17168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "%s%08lx ", i++ % 0x08 ? " " : "\n", *dst); 17268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 17368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot dst++; 17468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 17568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // IN_PORT_STRING_32 17668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 177543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid IN_PORT_STRING_8_16( hcf_io prt, hcf_8 FAR * dst, int n) { //also handles byte alignment problems 178543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 FAR * p = (hcf_16 FAR *)dst; //this needs more elaborate code in non-x86 platforms 17968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot int i = 0; 18068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 18168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nread string_16 length %04x (%04d) at port %02.2x to addr %lp", 182543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (hcf_16)n, (hcf_16)n, (hcf_16)(prt)&0xFF, dst ); 18368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 18468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( n-- ) { 18568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *p =(hcf_16)_inpw( prt); 18668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 18768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i++ % 0x10 ) { 18868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "%04x ", *p); 18968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 19068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\n%04x ", *p); 19168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 19268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 19368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p++; 19468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 19568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // IN_PORT_STRING_8_16 19668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 197543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid OUT_PORT_STRING_32( hcf_io prt, hcf_32 FAR * src, int n) { 19868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot int i = 0; 19968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_16 FAR * p; 20068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 20168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nwrite string_32 length %04x (%04d) at port %02.2x", 202543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (hcf_16)n, (hcf_16)n, (hcf_16)(prt)&0xFF); 20368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 20468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( n-- ) { 20568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = (hcf_16 FAR *)src; 20668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot _outpw( prt, *p++ ); 20768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot _outpw( prt, *p ); 20868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 20968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "%s%08lx ", i++ % 0x08 ? " " : "\n", *src); 21068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 21168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot src++; 21268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 21368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // OUT_PORT_STRING_32 21468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 215543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyvoid OUT_PORT_STRING_8_16( hcf_io prt, hcf_8 FAR * src, int n) { //also handles byte alignment problems 216543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 FAR * p = (hcf_16 FAR *)src; //this needs more elaborate code in non-x86 platforms 21768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot int i = 0; 21868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 21968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\nwrite string_16 length %04x (%04d) at port %04x", n, n, (hcf_16)prt); 22068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 22168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( n-- ) { 22268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)_outpw( prt, *p); 22368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( log_file ) { 22468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i++ % 0x10 ) { 22568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "%04x ", *p); 22668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 22768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fprintf( log_file, "\n%04x ", *p); 22868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 22968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 23068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p++; 23168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 23268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // OUT_PORT_STRING_8_16 23368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 23468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // IN_PORT_WORD 23568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 23668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 237543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ******************************* D A T A D E F I N I T I O N S ******************************************** 238543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 23968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 24068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 241543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyIFBP BASED assert_ifbp = NULL; //to make asserts easily work under MMD and DHF 24268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 24368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 24468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* SNAP header to be inserted in Ethernet-II frames */ 245543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC hcf_8 BASED snap_header[] = { 0xAA, 0xAA, 0x03, 0x00, 0x00, //5 bytes signature + 246543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 0 }; //1 byte protocol identifier 24768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 24868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 249543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David KilroyHCF_STATIC hcf_8 BASED mic_pad[8] = { 0x5A, 0, 0, 0, 0, 0, 0, 0 }; //MIC padding of message 25068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 25168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 25268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined MSF_COMPONENT_ID 25368c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootCFG_IDENTITY_STRCT BASED cfg_drv_identity = { 254543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_identity)/sizeof(hcf_16) - 1, //length of RID 255543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_IDENTITY, // (0x0826) 25668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot MSF_COMPONENT_ID, 25768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot MSF_COMPONENT_VAR, 25868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot MSF_COMPONENT_MAJOR_VER, 25968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot MSF_COMPONENT_MINOR_VER 26068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 26168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 26268c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootCFG_RANGES_STRCT BASED cfg_drv_sup_range = { 263543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_sup_range)/sizeof(hcf_16) - 1, //length of RID 264543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_SUP_RANGE, // (0x0827) 26568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 26668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ROLE_SUPL, 26768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ID_DUI, 268543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy {{ DUI_COMPAT_VAR, 269543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DUI_COMPAT_BOT, 270543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DUI_COMPAT_TOP 27168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot }} 27268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 27368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 27468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstruct CFG_RANGE3_STRCT BASED cfg_drv_act_ranges_pri = { 275543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_act_ranges_pri)/sizeof(hcf_16) - 1, //length of RID 276543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_PRI, // (0x0828) 27768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 27868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ROLE_ACT, 27968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ID_PRI, 28068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 281543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, // HCF_PRI_VAR_1 not supported by HCF 7 282543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, // HCF_PRI_VAR_2 not supported by HCF 7 283543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 3, //var_rec[2] - Variant number 284543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_PRI_3_BOTTOM, // - Bottom Compatibility 285543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_PRI_3_TOP // - Top Compatibility 286543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 28768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 28868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 28968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 29068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 29168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstruct CFG_RANGE4_STRCT BASED cfg_drv_act_ranges_sta = { 292543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_act_ranges_sta)/sizeof(hcf_16) - 1, //length of RID 293543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA, // (0x0829) 29468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 29568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ROLE_ACT, 29668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ID_STA, 29768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 29868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined HCF_STA_VAR_1 299543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 1, //var_rec[1] - Variant number 300543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_1_BOTTOM, // - Bottom Compatibility 301543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_1_TOP // - Top Compatibility 302543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 30368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 304543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 30568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_STA_VAR_1 30668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined HCF_STA_VAR_2 307543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 2, //var_rec[1] - Variant number 308543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_2_BOTTOM, // - Bottom Compatibility 309543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_2_TOP // - Top Compatibility 310543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 31168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 312543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 31368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_STA_VAR_2 31468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// For Native_USB (Not used!) 31568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined HCF_STA_VAR_3 316543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 3, //var_rec[1] - Variant number 317543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_3_BOTTOM, // - Bottom Compatibility 318543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_3_TOP // - Top Compatibility 319543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 32068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 321543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 32268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_STA_VAR_3 32368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// Warp 32468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined HCF_STA_VAR_4 325543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 4, //var_rec[1] - Variant number 326543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_4_BOTTOM, // - Bottom Compatibility 327543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_STA_4_TOP // - Top Compatibility 328543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 32968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 330543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 } 33168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_STA_VAR_4 33268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 33368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 33468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 33568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 33668c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstruct CFG_RANGE6_STRCT BASED cfg_drv_act_ranges_hsi = { 337543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_act_ranges_hsi)/sizeof(hcf_16) - 1, //length of RID 338543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI, // (0x082A) 33968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ROLE_ACT, 34068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ID_HSI, 34168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 342543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_HSI_VAR_0 // Controlled deployment 343543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, // var_rec[1] - Variant number 344543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_0_BOTTOM, // - Bottom Compatibility 345543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_0_TOP // - Top Compatibility 346543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 34768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 348543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 34968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_HSI_VAR_0 350543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, // HCF_HSI_VAR_1 not supported by HCF 7 351543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, // HCF_HSI_VAR_2 not supported by HCF 7 352543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, // HCF_HSI_VAR_3 not supported by HCF 7 353543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_HSI_VAR_4 // Hermes-II all types 354543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 4, // var_rec[1] - Variant number 355543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_4_BOTTOM, // - Bottom Compatibility 356543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_4_TOP // - Top Compatibility 357543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 35868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 359543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 36068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_HSI_VAR_4 361543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_HSI_VAR_5 // WARP Hermes-2.5 362543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 5, // var_rec[1] - Variant number 363543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_5_BOTTOM, // - Bottom Compatibility 364543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_HSI_5_TOP // - Top Compatibility 365543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 36668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 367543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 } 36868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_HSI_VAR_5 36968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 37068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 37168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 37268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 37368c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootCFG_RANGE4_STRCT BASED cfg_drv_act_ranges_apf = { 374543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy sizeof(cfg_drv_act_ranges_apf)/sizeof(hcf_16) - 1, //length of RID 375543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF, // (0x082B) 37668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 37768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ROLE_ACT, 37868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot COMP_ID_APF, 37968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 380543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_APF_VAR_1 //(Fake) Hermes-I 381543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 1, //var_rec[1] - Variant number 382543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_1_BOTTOM, // - Bottom Compatibility 383543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_1_TOP // - Top Compatibility 384543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 38568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 386543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 38768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_APF_VAR_1 388543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_APF_VAR_2 //Hermes-II 389543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 2, // var_rec[1] - Variant number 390543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_2_BOTTOM, // - Bottom Compatibility 391543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_2_TOP // - Top Compatibility 392543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 39368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 394543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 39568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_APF_VAR_2 396543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_APF_VAR_3 // Native_USB 397543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 3, // var_rec[1] - Variant number 398543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_3_BOTTOM, // - Bottom Compatibility !!!!!see note below!!!!!!! 399543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_3_TOP // - Top Compatibility 400543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy }, 40168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 402543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 }, 40368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_APF_VAR_3 404543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined HCF_APF_VAR_4 // WARP Hermes 2.5 405543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 4, // var_rec[1] - Variant number 406543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_4_BOTTOM, // - Bottom Compatibility !!!!!see note below!!!!!!! 407543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DRV_ACT_RANGES_APF_4_TOP // - Top Compatibility 408543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 40968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 410543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 0, 0, 0 } 41168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_APF_VAR_4 41268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 41368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} ; 41468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define HCF_VERSION TEXT( "HCF$Revision: 1.10 $" ) 41568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 41668c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootstatic struct /*CFG_HCF_OPT_STRCT*/ { 417543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 len; //length of cfg_hcf_opt struct 418543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 typ; //type 0x082C 419543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v0; //offset HCF_VERSION 420543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v1; // MSF_COMPONENT_ID 421543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v2; // HCF_ALIGN 422543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v3; // HCF_ASSERT 423543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v4; // HCF_BIG_ENDIAN 424543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v5; // /* HCF_DLV | HCF_DLNV */ 425543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v6; // HCF_DMA 426543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v7; // HCF_ENCAP 427543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v8; // HCF_EXT 428543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v9; // HCF_INT_ON 429543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v10; // HCF_IO 430543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v11; // HCF_LEGACY 431543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v12; // HCF_MAX_LTV 432543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v13; // HCF_PROT_TIME 433543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v14; // HCF_SLEEP 434543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v15; // HCF_TALLIES 435543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v16; // HCF_TYPE 436543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v17; // HCF_NIC_TAL_CNT 437543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v18; // HCF_HCF_TAL_CNT 438543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 v19; // offset tallies 4397a9541c3246a6c8b1129f1668fe5e83f1f8b7354David Kilroy char val[sizeof(HCF_VERSION)]; 44068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} BASED cfg_hcf_opt = { 44168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot sizeof(cfg_hcf_opt)/sizeof(hcf_16) -1, 442543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_HCF_OPT, // (0x082C) 44368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ( sizeof(cfg_hcf_opt) - sizeof(HCF_VERSION) - 4 )/sizeof(hcf_16), 44468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined MSF_COMPONENT_ID 44568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot MSF_COMPONENT_ID, 44668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 44768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 0, 44868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // MSF_COMPONENT_ID 44968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_ALIGN, 45068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_ASSERT, 45168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_BIG_ENDIAN, 452543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 0, // /* HCF_DLV | HCF_DLNV*/, 45368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_DMA, 45468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_ENCAP, 45568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_EXT, 45668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_INT_ON, 45768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_IO, 45868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_LEGACY, 45968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_MAX_LTV, 46068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_PROT_TIME, 46168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_SLEEP, 46268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_TALLIES, 46368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_TYPE, 46468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TALLIES) & ( HCF_TALLIES_NIC | HCF_TALLIES_HCF ) 46568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_NIC_TAL_CNT, 46668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_HCF_TAL_CNT, 46768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot offsetof(IFB_STRCT, IFB_TallyLen ), 46868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 46968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 0, 0, 0, 47068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TALLIES_NIC / HCF_TALLIES_HCF 47168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_VERSION 47268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot}; // cfg_hcf_opt 47368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // MSF_COMPONENT_ID 47468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 47568c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC LTV_STRCT BASED cfg_null = { 1, CFG_NULL, {0} }; 4767c22429923c393853687266cd9d99c13c688f0a1David Kilroy 47768c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC hcf_16* BASED xxxx[ ] = { 478543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_null.len, //CFG_NULL 0x0820 47968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined MSF_COMPONENT_ID 480543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_identity.len, //CFG_DRV_IDENTITY 0x0826 481543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_sup_range.len, //CFG_DRV_SUP_RANGE 0x0827 482543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_act_ranges_pri.len, //CFG_DRV_ACT_RANGES_PRI 0x0828 483543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_act_ranges_sta.len, //CFG_DRV_ACT_RANGES_STA 0x0829 484543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_act_ranges_hsi.len, //CFG_DRV_ACT_RANGES_HSI 0x082A 485543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_drv_act_ranges_apf.len, //CFG_DRV_ACT_RANGES_APF 0x082B 486543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy &cfg_hcf_opt.len, //CFG_HCF_OPT 0x082C 487543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy NULL, //IFB_PRIIdentity placeholder 0xFD02 488543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy NULL, //IFB_PRISup placeholder 0xFD03 48968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // MSF_COMPONENT_ID 490543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy NULL //endsentinel 491543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy}; 492543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#define xxxx_PRI_IDENTITY_OFFSET (ARRAY_SIZE(xxxx) - 3) 49368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 49468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 49568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 496543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************** T O P L E V E L H C F R O U T I N E S ************************************** 497543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 49868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 49968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 500543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 501543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_action( IFBP ifbp, hcf_16 action ) 502543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Changes the run-time Card behavior. 503543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Performs Miscellanuous actions. 504543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 505543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 506543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 507543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * action number identifying the type of change 508543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_INT_FORCE_ON enable interrupt generation by WaveLAN NIC 509543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_INT_OFF disable interrupt generation by WaveLAN NIC 510543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_INT_ON compensate 1 HCF_ACT_INT_OFF, enable interrupt generation if balance reached 511543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_PRS_SCAN Hermes Probe Respons Scan (F102) command 512543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_RX_ACK acknowledge non-DMA receiver to Hermes 513543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_SCAN Hermes Inquire Scan (F101) command (non-WARP only) 514543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_SLEEP DDS Sleep request 515543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_TALLIES Hermes Inquire Tallies (F100) command 516543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 517543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 518543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS all (including invalid) 519543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_INT_PENDING HCF_ACT_INT_OFF, interrupt pending 520543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC HCF_ACT_INT_OFF, NIC presence check fails 521543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 522543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.CONDITIONS 523543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Except for hcf_action with HCF_ACT_INT_FORCE_ON or HCF_ACT_INT_OFF as parameter or hcf_connect with an I/O 524543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * address (i.e. not HCF_DISCONNECT), all hcf-function calls MUST be preceded by a call of hcf_action with 525543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ACT_INT_OFF as parameter. 526543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that hcf_connect defaults to NIC interrupt disabled mode, i.e. as if hcf_action( HCF_ACT_INT_OFF ) 527543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * was called. 528543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 529543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 530543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_action supports the following mode changing action-code pairs that are antonyms 531543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_INT_[FORCE_]ON / HCF_ACT_INT_OFF 532543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 533543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Additionally hcf_action can start the following actions in the NIC: 534543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_PRS_SCAN 535543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_RX_ACK 536543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_SCAN 537543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_SLEEP 538543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_TALLIES 539543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 540543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_INT_OFF: Sets NIC Interrupts mode Disabled. 541543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This command, and the associated [Force] Enable NIC interrupts command, are only available if the HCF_INT_ON 542543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * compile time option is not set at 0x0000. 543543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 544543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_INT_ON: Sets NIC Interrupts mode Enabled. 545543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Enable NIC Interrupts, depending on the number of preceding Disable NIC Interrupt calls. 546543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 547543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_INT_FORCE_ON: Force NIC Interrupts mode Enabled. 548543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Sets NIC Interrupts mode Enabled, regardless off the number of preceding Disable NIC Interrupt calls. 549543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 550543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The disabling and enabling of interrupts are antonyms. 551543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * These actions must be balanced. 552543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For each "disable interrupts" there must be a matching "enable interrupts". 553543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The disable interrupts may be executed multiple times in a row without intervening enable interrupts, in 554543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * other words, the disable interrupts may be nested. 555543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The interrupt generation mechanism is disabled at the first call with HCF_ACT_INT_OFF. 556543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The interrupt generation mechanism is re-enabled when the number of calls with HCF_ACT_INT_ON matches the 557543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * number of calls with INT_OFF. 558543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 559543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * It is not allowed to have more Enable NIC Interrupts calls than Disable NIC Interrupts calls. 560543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The interrupt generation mechanism is initially (i.e. after hcf_connect) disabled. 561543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * An MSF based on a interrupt strategy must call hcf_action with INT_ON in its initialization logic. 562543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 563543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *! The INT_OFF/INT_ON housekeeping is initialized at 0x0000 by hcf_connect, causing the interrupt generation 564543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * mechanism to be disabled at first. This suits MSF implementation based on a polling strategy. 565543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 566543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_SLEEP: Initiates the Disconnected DeepSleep process 567543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This command is only available if the HCF_DDS compile time option is set. It triggers the F/W to start the 568543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * sleep handshaking. Regardless whether the Host initiates a Disconnected DeepSleep (DDS) or the F/W initiates 569543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a Connected DeepSleep (CDS), the Host-F/W sleep handshaking is completed when the NIC Interrupts mode is 570543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * enabled (by means of the balancing HCF_ACT_INT_ON), i.e. at that moment the F/W really goes into sleep mode. 571543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The F/W is wokenup by the HCF when the NIC Interrupts mode are disabled, i.e. at the first HCF_ACT_INT_OFF 572543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * after going into sleep. 573543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 574543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The following Miscellanuous actions are defined: 575543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 576543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_RX_ACK: Receiver Acknowledgement (non-DMA, non-USB mode only) 577543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Acking the receiver, frees the NIC memory used to hold the Rx frame and allows the F/W to 578543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * report the existence of the next Rx frame. 579543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the MSF does not need access (any longer) to the current frame, e.g. because it is rejected based on the 580543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * look ahead or copied to another buffer, the receiver may be acked. Acking earlier is assumed to have the 581543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * potential of improving the performance. 582543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the MSF does not explitly ack te receiver, the acking is done implicitly if: 583543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the received frame fits in the look ahead buffer, by the hcf_service_nic call that reported the Rx frame 584543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - if not in the above step, by hcf_rcv_msg (assuming hcf_rcv_msg is called) 585543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - if neither of the above implicit acks nor an explicit ack by the MSF, by the first hcf_service_nic after 586543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the hcf_service_nic that reported the Rx frame. 587543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: If an Rx frame is already acked, an explicit ACK by the MSF acts as a NoOperation. 588543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 589543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_TALLIES: Inquire Tallies command 590543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This command is only operational if the F/W is enabled. 591543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Inquire Tallies command requests the F/W to provide its current set of tallies. 592543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * See also hcf_get_info with CFG_TALLIES as parameter. 593543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 594543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_PRS_SCAN: Inquire Probe Respons Scan command 595543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This command is only operational if the F/W is enabled. 596543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Probe Respons Scan command starts a scan sequence. 597543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF puts the result of this action in an MSF defined buffer (see CFG_RID_LOG_STRCT). 598543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 599543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o HCF_ACT_SCAN: Inquire Scan command 600543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This command is only supported for HII F/W (i.e. pre-WARP) and it is operational if the F/W is enabled. 601543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Inquire Scan command starts a scan sequence. 602543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF puts the result of this action in an MSF defined buffer (see CFG_RID_LOG_STRCT). 603543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 604543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 605543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 606543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - NIC interrupts are not disabled while required by parameter action. 607543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - an invalid code is specified in parameter action. 608543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_ACT_INT_ON commands outnumber the HCF_ACT_INT_OFF commands. 609543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling hcf_functions without adequate protection against NIC interrupts or 610543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * multi-threading 611543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 612543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Since the HCF does not maintain status information relative to the F/W enabled state, it is not asserted 613543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * whether HCF_ACT_SCAN, HCF_ACT_PRS_SCAN or HCF_ACT_TALLIES are only used while F/W is enabled. 614543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 615543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 616543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0: The assert embedded in HCFLOGENTRY checks against re-entrancy. Re-entrancy could be caused by a MSF logic 617543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * at task-level calling hcf_functions without shielding with HCF_ACT_ON/_OFF. However the HCF_ACT_INT_OFF 618543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * action itself can per definition not be protected this way. Based on code inspection, it can be concluded, 619543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * that there is no re-entrancy PROBLEM in this particular flow. It does not seem worth the trouble to 620543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * explicitly check for this condition (although there was a report of an MSF which ran into this assert. 621543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2:IFB_IntOffCnt is used to balance the INT_OFF and INT_ON calls. Disabling of the interrupts is achieved by 622543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * writing a zero to the Hermes IntEn register. In a shared interrupt environment (e.g. the mini-PCI NDIS 623543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * driver) it is considered more correct to return the status HCF_INT_PENDING if and only if, the current 624543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * invocation of hcf_service_nic is (apparently) called in the ISR when the ISR was activated as result of a 625543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * change in HREG_EV_STAT matching a bit in HREG_INT_EN, i.e. not if invoked as result of another device 626543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * generating an interrupt on the shared interrupt line. 627543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 1: it has been observed that under certain adverse conditions on certain platforms the writing of 628543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HREG_INT_EN can apparently fail, therefor it is paramount that HREG_INT_EN is written again with 0 for 629543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * each and every call to HCF_ACT_INT_OFF. 630543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 2: it has been observed that under certain H/W & S/W architectures this logic is called when there is 631543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * no NIC at all. To cater for this, the value of HREG_INT_EN is validated. If the unused bit 0x0100 is set, 632543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * it is assumed there is no NIC. 633543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 3: During the download process, some versions of the F/W reset HREG_SW_0, hence checking this 634543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * register for HCF_MAGIC (the classical NIC presence test) when HCF_ACT_INT_OFF is called due to another 635543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * card interrupting via a shared IRQ during a download, fails. 636543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: The construction "if ( ifbp->IFB_IntOffCnt-- == 0 )" is optimal (in the sense of shortest/quickest 637543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * path in error free flows) but NOT fail safe in case of too many INT_ON invocations compared to INT_OFF). 638543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Enabling of the interrupts is achieved by writing the Hermes IntEn register. 639543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - If the HCF is in Defunct mode, the interrupts stay disabled. 640543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Under "normal" conditions, the HCF is only interested in Info Events, Rx Events and Notify Events. 641543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - When the HCF is out of Tx/Notify resources, the HCF is also interested in Alloc Events. 642543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - via HCF_EXT, the MSF programmer can also request HREG_EV_TICK and/or HREG_EV_TX_EXC interrupts. 643543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For DMA operation, the DMA hardware handles the alloc events. The DMA engine will generate a 'TxDmaDone' 644543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * event as soon as it has pumped a frame from host ram into NIC-RAM (note that the frame does not have to be 645543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * transmitted then), and a 'RxDmaDone' event as soon as a received frame has been pumped from NIC-RAM into 646543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * host ram. Note that the 'alloc' event has been removed from the event-mask, because the DMA engine will 647543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * react to and acknowledge this event. 648543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: ack the "old" Rx-event. See "Rx Buffer free strategy" in hcf_service_nic above for more explanation. 649543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_RxFID and IFB_RxLen must be cleared to bring both the internal HCF house keeping and the information 650543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * supplied to the MSF in the state "no frame received". 651543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: The HCF_ACT_SCAN, HCF_ACT_PRS_SCAN and HCF_ACT_TALLIES activity are merged by "clever" algebraic 652543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * manipulations of the RID-values and action codes, so foregoing robustness against migration problems for 653543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ease of implementation. The assumptions about numerical relationships between CFG_TALLIES etc and 654543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ACT_TALLIES etc are checked by the "#if" statements just prior to the body of this routine, resulting 655543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in: err "maintenance" during compilation if the assumptions are no longer met. The writing of HREG_PARAM_1 656543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * with 0x3FFF in case of an PRS scan, is a kludge to get around lack of specification, hence different 657543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * implementation in F/W and Host. 658543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When there is no NIC RAM available, some versions of the Hermes F/W do report 0x7F00 as error in the 659543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Result field of the Status register and some F/W versions don't. To mask this difference to the MSF all 660543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * return codes of the Hermes are ignored ("best" and "most simple" solution to these types of analomies with 661543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * an acceptable loss due to ignoring all error situations as well). 662543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The "No inquire space" is reported via the Hermes tallies. 663543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *30: do not HCFASSERT( rc, rc ) since rc == HCF_INT_PENDING is no error 664543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 665543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 666543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 667543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 66868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_HII5 ) == 0 66968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if CFG_SCAN != CFG_TALLIES - HCF_ACT_TALLIES + HCF_ACT_SCAN 67068c0bdff7ac903421f224e080499c51cd5287f97Henk de Grooterr: "maintenance" apparently inviolated the underlying assumption about the numerical values of these macros 67168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif 67268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_HII5 67368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if CFG_PRS_SCAN != CFG_TALLIES - HCF_ACT_TALLIES + HCF_ACT_PRS_SCAN 67468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grooterr: "maintenance" apparently inviolated the underlying assumption about the numerical values of these macros 67568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif 67668c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 67768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_action( IFBP ifbp, hcf_16 action ) 67868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 679543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 68068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 681788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 68268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_INT_ON 683543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFLOGENTRY( action == HCF_ACT_INT_FORCE_ON ? HCF_TRACE_ACTION_KLUDGE : HCF_TRACE_ACTION, action ); /* 0 */ 68468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_SLEEP) 68568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFASSERT( ifbp->IFB_IntOffCnt != 0xFFFE || action == HCF_ACT_INT_OFF, 686543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy MERGE_2( action, ifbp->IFB_IntOffCnt ) ); 68768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 688788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_IntOffCnt != 0xFFFE, action ); 68968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_SLEEP 69068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFASSERT( ifbp->IFB_IntOffCnt != 0xFFFF || 691543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy action == HCF_ACT_INT_OFF || action == HCF_ACT_INT_FORCE_ON, action ); 69268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFASSERT( ifbp->IFB_IntOffCnt <= 16 || ifbp->IFB_IntOffCnt >= 0xFFFE, 693543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy MERGE_2( action, ifbp->IFB_IntOffCnt ) ); //nesting more than 16 deep seems unreasonable 69468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_INT_ON 69568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 69668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot switch (action) { 69768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_INT_ON 698543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 699543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_INT_OFF: // Disable Interrupt generation 70068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_SLEEP 701543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_IntOffCnt == 0xFFFE ) { // WakeUp test ;?tie this to the "new" super-LinkStat 702543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_IntOffCnt++; // restore conventional I/F 703543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW(HREG_IO, HREG_IO_WAKEUP_ASYNC ); // set wakeup bit 704543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW(HREG_IO, HREG_IO_WAKEUP_ASYNC ); // set wakeup bit to counteract the clearing by F/W 70568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // 800 us latency before FW switches to high power 706543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy MSF_WAIT(800); // MSF-defined function to wait n microseconds. 707543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//OOR if ( ifbp->IFB_DSLinkStat & CFG_LINK_STAT_DS_OOR ) { // OutOfRange 708543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// printk( "<5>ACT_INT_OFF: Deepsleep phase terminated, enable and go to AwaitConnection\n" ); //;?remove me 1 day 70968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// hcf_cntl( ifbp, HCF_CNTL_ENABLE ); 71068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// } 711543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_DSLinkStat &= ~( CFG_LINK_STAT_DS_IR | CFG_LINK_STAT_DS_OOR); //clear IR/OOR state 71268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 71368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_SLEEP 714543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*2*/ ifbp->IFB_IntOffCnt++; 715543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//! rc = 0; 71668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = IPW( HREG_INT_EN ); 71768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_INT_EN, 0 ); 71868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i & 0x1000 ) { 71968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_NO_NIC; 72068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 72168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i & IPW( HREG_EV_STAT ) ) { 72268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_INT_PENDING; 72368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 72468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 72568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 72668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 727543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_INT_FORCE_ON: // Enforce Enable Interrupt generation 72868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_IntOffCnt = 0; 72968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //Fall through in HCF_ACT_INT_ON 73068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 731543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_INT_ON: // Enable Interrupt generation 732543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*4*/ if ( ifbp->IFB_IntOffCnt-- == 0 && ifbp->IFB_CardStat == 0 ) { 733543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //determine Interrupt Event mask 73468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 73568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_CntlOpt & USE_DMA ) { 736543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = HREG_EV_INFO | HREG_EV_RDMAD | HREG_EV_TDMAD | HREG_EV_TX_EXT; //mask when DMA active 73768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else 73868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 73968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 740543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = HREG_EV_INFO | HREG_EV_RX | HREG_EV_TX_EXT; //mask when DMA not active 74168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_RscInd == 0 ) { 742543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i |= HREG_EV_ALLOC; //mask when no TxFID available 74368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 74468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 74568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_SLEEP 74668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ( IPW(HREG_EV_STAT) & ( i | HREG_EV_SLEEP_REQ ) ) == HREG_EV_SLEEP_REQ ) { 74768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // firmware indicates it would like to go into sleep modus 74868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // only acknowledge this request if no other events that can cause an interrupt are pending 749543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_IntOffCnt--; //becomes 0xFFFE 750543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_INT_EN, i | HREG_EV_TICK ); 75168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_EV_ACK, HREG_EV_SLEEP_REQ | HREG_EV_TICK | HREG_EV_ACK_REG_READY ); 75268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else 75368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_SLEEP 75468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 755543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_INT_EN, i | HREG_EV_SLEEP_REQ ); 75668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 75768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 75868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 75968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_INT_ON 76068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 76168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_SLEEP) & HCF_DDS 762543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_SLEEP: // DDS Sleep request 76368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_cntl( ifbp, HCF_CNTL_DISABLE ); 76468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot cmd_exe( ifbp, HCMD_SLEEP, 0 ); 76568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 766543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// case HCF_ACT_WAKEUP: // DDS Wakeup request 767543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// HCFASSERT( ifbp->IFB_IntOffCnt == 0xFFFE, ifbp->IFB_IntOffCnt ); 768543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_IntOffCnt++; // restore conventional I/F 769543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// OPW( HREG_IO, HREG_IO_WAKEUP_ASYNC ); 770543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// MSF_WAIT(800); // MSF-defined function to wait n microseconds. 771543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// rc = hcf_action( ifbp, HCF_ACT_INT_OFF ); /*bogus, IFB_IntOffCnt == 0xFFFF, so if you carefully look 772543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// *at the #if HCF_DDS statements, HCF_ACT_INT_OFF is empty 773543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// *for DDS. "Much" better would be to merge the flows for 774543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// *DDS and DEEP_SLEEP 775543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// */ 776543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// break; 77768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DDS 77868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 779543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_RX_ACK: //Receiver ACK 780543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*6*/ if ( ifbp->IFB_RxFID ) { 78168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot DAWA_ACK( HREG_EV_RX ); 78268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 78368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RxFID = ifbp->IFB_RxLen = 0; 78468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 78568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 786543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*8*/ case HCF_ACT_PRS_SCAN: // Hermes PRS Scan (F102) 78768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_PARAM_1, 0x3FFF ); 788543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //Fall through in HCF_ACT_TALLIES 789543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_TALLIES: // Hermes Inquire Tallies (F100) 79068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_HII5 ) == 0 791543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case HCF_ACT_SCAN: // Hermes Inquire Scan (F101) 79268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_HII5 79368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /*!! the assumptions about numerical relationships between CFG_TALLIES etc and HCF_ACT_TALLIES etc 794543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * are checked by #if statements just prior to this routine resulting in: err "maintenance" */ 79568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot cmd_exe( ifbp, HCMD_INQUIRE, action - HCF_ACT_TALLIES + CFG_TALLIES ); 79668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 79768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 798543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy default: 799788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, action ); 80068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 80168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 802543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //! do not HCFASSERT( rc == HCF_SUCCESS, rc ) /* 30*/ 803788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_ACTION ); 80468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 80568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_action 80668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 80768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 80868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 809543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 810543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_cntl( IFBP ifbp, hcf_16 cmd ) 811543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Connect or disconnect a specific port to a specific network. 812543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! ;???????????????? continue needs more explanation 813543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * recovers by means of "continue" when the connect process in CCX mode fails 814543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Enables or disables data transmission and reception for the NIC. 815543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Activates static NIC configuration for a specific port at connect. 816543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Activates static configuration for all ports at enable. 817543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 818543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 819543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 820543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * cmd 0x001F: Hermes command (disable, enable, connect, disconnect, continue) 821543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_CNTL_ENABLE Enable 822543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_CNTL_DISABLE Disable 823543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_CNTL_CONTINUE Continue 824543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_CNTL_CONNECT Connect 825543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_CNTL_DISCONNECT Disconnect 826543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0x0100: command qualifier (continue) 827543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCMD_RETRY retry flag 828543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0x0700: port number (connect/disconnect) 829543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_0 MAC Port 0 830543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_1 MAC Port 1 831543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_2 MAC Port 2 832543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_3 MAC Port 3 833543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_4 MAC Port 4 834543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_5 MAC Port 5 835543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_6 MAC Port 6 836543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 837543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 838543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 839543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via cmd_exe 840543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC 841543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_... 842543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT 843543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 844543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 845543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The parameter cmd contains a number of subfields. 846543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The actual value for cmd is created by logical or-ing the appropriate mnemonics for the subfields. 847543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The field 0x001F contains the command code 848543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_CNTL_ENABLE 849543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_CNTL_DISABLE 850543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_CNTL_CONNECT 851543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_CNTL_DISCONNECT 852543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HCF_CNTL_CONTINUE 853543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 854543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For HCF_CNTL_CONTINUE, the field 0x0100 contains the retry flag HCMD_RETRY. 855543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For HCF_CNTL_CONNECT and HCF_CNTL_DISCONNECT, the field 0x0700 contains the port number as HCF_PORT_#. 856543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For Station as well as AccessPoint F/W, MAC Port 0 is the "normal" communication channel. 857543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For AccessPoint F/W, MAC Port 1 through 6 control the WDS links. 858543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 859543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that despite the names HCF_CNTL_DISABLE and HCF_CNTL_ENABLE, hcf_cntl does not influence the NIC 860543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Interrupts mode. 861543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 862543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Connect is used by the MSF to bring a particular port in an inactive state as far as data transmission 863543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and reception are concerned. 864543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When a particular port is disconnected: 865543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the F/W disables the receiver for that port. 866543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the F/W ignores send commands for that port. 867543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - all frames (Receive as well as pending Transmit) for that port on the NIC are discarded. 868543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 869543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When the NIC is disabled, above list applies to all ports, i.e. the result is like all ports are 870543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * disconnected. 871543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 872543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When a particular port is connected: 873543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the F/W effectuates the static configuration for that port. 874543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - enables the receiver for that port. 875543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - accepts send commands for that port. 876543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 877543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Enabling has the following effects: 878543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the F/W effectuates the static configuration for all ports. 879543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The F/W only updates its static configuration at a transition from disabled to enabled or from 880543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * disconnected to connected. 881543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In order to enforce the static configuration, the MSF must assure that such a transition takes place. 882543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Due to such a disable/enable or disconnect/connect sequence, Rx/Tx frames may be lost, in other words, 883543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * configuration may impact communication. 884543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The DMA Engine (if applicable) is enabled. 885543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that the Enable Function by itself only enables data transmission and reception, it 886543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * does not enable the Interrupt Generation mechanism. This is done by hcf_action. 887543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 888543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Disabling has the following effects: 889543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! ;?????is the following statement really true 890543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - it acts as a disconnect on all ports. 891543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The DMA Engine (if applicable) is disabled. 892543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 893543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For impact of the disable command on the behavior of hcf_dma_tx/rx_get see the appropriate sections. 894543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 895543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Although the Enable/Disable and Connect/Disconnect are antonyms, there is no restriction on their sequencing, 896543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in other words, they may be called multiple times in arbitrary sequence without being paired or balanced. 897543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Each time one of these functions is called, the effects of the preceding calls cease. 898543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 899543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 900543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 901543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - NIC interrupts are not disabled. 902543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - A command other than Continue, Enable, Disable, Connect or Disconnect is given. 903543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - An invalid combination of the subfields is given or a bit outside the subfields is given. 904543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - any return code besides HCF_SUCCESS. 905543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling a hcf_function without adequate protection against NIC interrupts or 906543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * multi-threading 907543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 908543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 909543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_cntl takes successively the following actions: 910543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: If the HCF is in Defunct mode or incompatible with the Primary or Station Supplier in the Hermes, 911543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_cntl() returns immediately with HCF_ERR_NO_NIC;? as status. 912543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: when the port is disabled, the DMA engine needs to be de-activated, so the host can safely reclaim tx 913543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * packets from the tx descriptor chain. 914543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 915543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 916543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 917543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 91868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 91968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_cntl( IFBP ifbp, hcf_16 cmd ) 92068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 921543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_ERR_INCOMP_FW; 92268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 923543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { int x = cmd & HCMD_CMD_CODE; 924543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( x == HCF_CNTL_CONTINUE ) x &= ~HCMD_RETRY; 925543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy else if ( (x == HCMD_DISABLE || x == HCMD_ENABLE) && ifbp->IFB_FWIdentity.comp_id == COMP_ID_FW_AP ) { 926543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy x &= ~HFS_TX_CNTL_PORT; 927543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 928543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( x==HCF_CNTL_ENABLE || x==HCF_CNTL_DISABLE || HCF_CNTL_CONTINUE || 929788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy x==HCF_CNTL_CONNECT || x==HCF_CNTL_DISCONNECT, cmd ); 930543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 93168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 93268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #if (HCF_SLEEP) & HCF_DDS 933543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// HCFASSERT( ifbp->IFB_IntOffCnt != 0xFFFE, cmd ); 93468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #endif // HCF_DDS 935788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_CNTL, cmd ); 936543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_CardStat == 0 ) { /*2*/ 937543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*6*/ rc = cmd_exe( ifbp, cmd, 0 ); 93868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_SLEEP) & HCF_DDS 939543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TickCnt = 0; //start 2 second period (with 1 tick uncertanty) 94068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DDS 94168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 94268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 94368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //!rlav : note that this piece of code is always executed, regardless of the DEFUNCT bit in IFB_CardStat. 94468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // The reason behind this is that the MSF should be able to get all its DMA resources back from the HCF, 94568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // even if the hardware is disfunctional. Practical example under Windows : surprise removal. 94668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_CntlOpt & USE_DMA ) { 94768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_io io_port = ifbp->IFB_IOBase; 94868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot DESC_STRCT *p; 94968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( cmd == HCF_CNTL_DISABLE || cmd == HCF_CNTL_ENABLE ) { 950543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OUT_PORT_DWORD( (io_port + HREG_DMA_CTRL), DMA_CTRLSTAT_RESET); /*8*/ 95168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CntlOpt &= ~DMA_ENABLED; 95268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 95368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( cmd == HCF_CNTL_ENABLE ) { 95468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_DWORD( (io_port + HREG_DMA_CTRL), DMA_CTRLSTAT_GO); 95568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* ;? by rewriting hcf_dma_rx_put you can probably just call hcf_dma_rx_put( ifbp->IFB_FirstDesc[DMA_RX] ) 95668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * as additional beneficiary side effect, the SOP and EOP bits will also be cleared 95768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot */ 95868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CntlOpt |= DMA_ENABLED; 959788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( NT_ASSERT, NEVER_TESTED ); 96068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // make the entire rx descriptor chain DMA-owned, so the DMA engine can (re-)use it. 961491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches p = ifbp->IFB_FirstDesc[DMA_RX]; 962491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches if (p != NULL) { //;? Think this over again in the light of the new chaining strategy 963543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( 1 ) { //begin alternative 964788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( NT_ASSERT, NEVER_TESTED ); 96568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frame_lst( ifbp, ifbp->IFB_FirstDesc[DMA_RX], DMA_RX ); 96668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_FirstDesc[DMA_RX] ) { 96768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frame_lst( ifbp, ifbp->IFB_FirstDesc[DMA_RX]->next_desc_addr, DMA_RX ); 96868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 96968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 97068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( p ) { 97168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //p->buf_cntl.cntl_stat |= DESC_DMA_OWNED; 97268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->BUF_CNT |= DESC_DMA_OWNED; 97368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = p->next_desc_addr; 97468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 97568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // a rx chain is available so hand it over to the DMA engine 97668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = ifbp->IFB_FirstDesc[DMA_RX]; 97768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_DWORD( (io_port + HREG_RXDMA_PTR32), p->desc_phys_addr); 97868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } //end alternative 97968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 98068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 98168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 98268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 983788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( rc == HCF_SUCCESS, rc ); 984788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_CNTL ); 98568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 98668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_cntl 98768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 98868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 98968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 990543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 991543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_connect( IFBP ifbp, hcf_io io_base ) 992543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Grants access right for the HCF to the IFB. 993543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Initializes Card and HCF housekeeping. 994543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 995543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 996543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp (near) address of the Interface Block 997543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * io_base non-USB: I/O Base address of the NIC (connect) 998543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * non-USB: HCF_DISCONNECT 999543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * USB: HCF_CONNECT, HCF_DISCONNECT 1000543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1001543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 1002543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 1003543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_INCOMP_PRI 1004543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_INCOMP_FW 1005543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_CMD_SEQ 1006543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! HCF_ERR_NO_NIC really returned ;? 1007543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC 1008543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT 1009543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1010543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * MSF-accessible fields of Result Block: 1011543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_IOBase entry parameter io_base 1012543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_IORange HREG_IO_RANGE (0x40/0x80) 1013543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_Version version of the IFB layout 1014543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_FWIdentity CFG_FW_IDENTITY_STRCT, specifies the identity of the 1015543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "running" F/W, i.e. tertiary F/W under normal conditions 1016543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_FWSup CFG_SUP_RANGE_STRCT, specifies the supplier range of 1017543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the "running" F/W, i.e. tertiary F/W under normal conditions 1018543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_HSISup CFG_SUP_RANGE_STRCT, specifies the HW/SW I/F range of the NIC 1019543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_PRIIdentity CFG_PRI_IDENTITY_STRCT, specifies the Identity of the Primary F/W 1020543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_PRISup CFG_SUP_RANGE_STRCT, specifies the supplier range of the Primary F/W 1021543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * all other all MSF accessible fields, which are not specified above, are zero-filled 1022543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1023543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.CONDITIONS 1024543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * It is the responsibility of the MSF to assure the correctness of the I/O Base address. 1025543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1026543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: hcf_connect defaults to NIC interrupt disabled mode, i.e. as if hcf_action( HCF_ACT_INT_OFF ) 1027543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * was called. 1028543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1029543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1030543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_connect passes the MSF-defined location of the IFB to the HCF and grants or revokes access right for the 1031543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF to the IFB. Revoking is done by specifying HCF_DISCONNECT rather than an I/O address for the parameter 1032543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * io_base. Every call of hcf_connect in "connect" mode, must eventually be followed by a call of hcf_connect 1033543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in "disconnect" mode. Clalling hcf_connect in "connect"/"disconnect" mode can not be nested. 1034543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The IFB address must be used as a handle with all subsequent HCF-function calls and the HCF uses the IFB 1035543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * address as a handle when it performs a call(back) of an MSF-function (i.e. msf_assert). 1036543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1037543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that not only the MSF accessible fields are cleared, but also all internal housekeeping 1038543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * information is re-initialized. 1039543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This implies that all settings which are done via hcf_action and hcf_put_info (e.g. CFG_MB_ASSERT, CFG_REG_MB, 1040543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * CFG_REG_INFO_LOG) must be done again. The only field which is not cleared, is IFB_MSFSup. 1041543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1042543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If HCF_INT_ON is selected as compile option, NIC interrupts are disabled. 1043543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1044543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 1045543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp is not properly aligned ( ref chapter HCF_ALIGN in 4.1.1) 1046543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - I/O Base Address is not a multiple of 0x40 (note: 0x0000 is explicitly allowed). 1047543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1048543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1049543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1050543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *0: Throughout hcf_connect you need to distinguish the connect from the disconnect case, which requires 1051543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * some attention about what to use as "I/O" address when for which purpose. 1052543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: 1053543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2a: Reset H-II by toggling reset bit in IO-register on and off. 1054543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF_TYPE_PRELOADED caters for the DOS environment where H-II is loaded by a separate program to 1055543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * overcome the 64k size limit posed on DOS drivers. 1056543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The macro OPW is not yet useable because the IFB_IOBase field is not set. 1057543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 1: hopefully the clearing and initializing of the IFB (see below) acts as a delay which meets the 1058543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * specification for S/W reset 1059543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 2: it turns out that on some H/W constellations, the clock to access the EEProm is not lowered 1060543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to an appropriate frequency by HREG_IO_SRESET. By giving an HCMD_INI first, this problem is worked around. 1061543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2b: Experimentally it is determined over a wide range of F/W versions that waiting for the for Cmd bit in 1062543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Ev register gives a workable strategy. The available documentation does not give much clues. 1063543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: clear and initialize the IFB 1064543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF house keeping info is designed such that zero is the appropriate initial value for as much as 1065543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * feasible IFB-items. 1066543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The readable fields mentioned in the description section and some HCF specific fields are given their 1067543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * actual value. 1068543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_TickIni is initialized at best guess before calibration 1069543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hcf_connect defaults to "no interrupt generation" (implicitly achieved by the zero-filling). 1070543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: Register compile-time linked MSF Routine and set default filter level 1071543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * cast needed to get around the "near" problem in DOS COM model 1072543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * er C2446: no conversion from void (__near __cdecl *)(unsigned char __far *,unsigned int,unsigned short,int) 1073543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to void (__far __cdecl *)(unsigned char __far *,unsigned int,unsigned short,int) 1074543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: If a command is apparently still active (as indicated by the Busy bit in Cmd register) this may indicate a 1075543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * blocked cmd pipe line. To unblock the following actions are done: 1076543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Ack everything 1077543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Wait for Busy bit drop in Cmd register 1078543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Wait for Cmd bit raise in Ev register 1079543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The two waits are combined in a single HCF_WAIT_WHILE to optimize memory size. If either of these waits 1080543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * fail (prot_cnt becomes 0), then something is serious wrong. Rather than PANICK, the assumption is that the 1081543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * next cmd_exe will fail, causing the HCF to go into DEFUNCT mode 1082543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *10: Ack everything to unblock a (possibly blocked) cmd pipe line 1083543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 1: it is very likely that an Alloc event is pending and very well possible that a (Send) Cmd event is 1084543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pending on non-initial calls 1085543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 2: it is assumed that this strategy takes away the need to ack every conceivable event after an 1086543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hermes Initialize 1087543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *12: Only H-II NEEDS the Hermes Initialize command. Due to the different semantics for H-I and H-II 1088543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Initialize command, init() does not (and can not, since it is called e.g. after a download) execute the 1089543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hermes Initialize command. Executing the Hermes Initialize command for H-I would not harm but not do 1090543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * anything useful either, so it is skipped. 1091543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The return status of cmd_exe is ignored. It is assumed that if cmd_exe fails, init fails too 1092543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *14: use io_base as a flag to merge hcf_connect and hcf_disconnect into 1 routine 1093543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the call to init and its subsequent call of cmd_exe will return HCF_ERR_NO_NIC if appropriate. This status 1094543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is (badly) needed by some legacy combination of NT4 and card services which do not yield an I/O address in 1095543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * time. 1096543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1097543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1098543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On platforms where the NULL-pointer is not a bit-pattern of all zeros, the zero-filling of the IFB results 1099543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in an incorrect initialization of pointers. 1100543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The implementation of the MailBox manipulation in put_mb_info protects against the absence of a MailBox 1101543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * based on IFB_MBSize, IFB_MBWp and ifbp->IFB_MBRp. This has ramifications on the initialization of the 1102543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * MailBox via hcf_put_info with the CFG_REG_MB type, but it prevents dependency on the "NULL-"ness of 1103543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_MBp. 1104543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1105543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1106543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * There are a number of problems when asserting and logging hcf_connect, e.g. 1107543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Asserting on re-entrancy of hcf_connect by means of 1108543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "HCFASSERT( (ifbp->IFB_AssertTrace & HCF_ASSERT_CONNECT) == 0, 0 )" is not useful because IFB contents 1109543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * are undefined 1110543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Asserting before the IFB is cleared will cause mdd_assert() to interpret the garbage in IFB_AssertRtn 1111543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * as a routine address 1112543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Therefore HCFTRACE nor HCFLOGENTRY is called by hcf_connect. 1113543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1114543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1115543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 111668c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 111768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_connect( IFBP ifbp, hcf_io io_base ) 111868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 1119543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 1120543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_io io_addr; 1121543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 prot_cnt; 1122543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_8 *q; 1123543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy LTV_STRCT x; 112468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 112568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_16 xa = ifbp->IFB_FWIdentity.typ; 112668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* is assumed to cause an assert later on if hcf_connect is called without intervening hcf_disconnect. 112768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * xa == CFG_FW_IDENTITY in subsequent calls without preceding hcf_disconnect, 112868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * xa == 0 in subsequent calls with preceding hcf_disconnect, 112968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * xa == "garbage" (any value except CFG_FW_IDENTITY is acceptable) in the initial call 113068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot */ 113168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 113268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1133543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( io_base == HCF_DISCONNECT ) { //disconnect 113468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot io_addr = ifbp->IFB_IOBase; 1135543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_INT_EN, 0 ); //;?workaround against dying F/W on subsequent hcf_connect calls 1136543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else { //connect /* 0 */ 113768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot io_addr = io_base; 113868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 113968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 114025985edcedea6396277003854657b5f3cb31a628Lucas De Marchi#if 0 //;? if a subsequent hcf_connect is preceded by an hcf_disconnect the wakeup is not needed !! 114168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_SLEEP 1142543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OUT_PORT_WORD( .....+HREG_IO, HREG_IO_WAKEUP_ASYNC ); //OPW not yet useable 1143543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy MSF_WAIT(800); // MSF-defined function to wait n microseconds. 114468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot note that MSF_WAIT uses not yet defined!!!! IFB_IOBase and IFB_TickIni (via PROT_CNT_INI) 114525985edcedea6396277003854657b5f3cb31a628Lucas De Marchi so be careful if this code is restored 114668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_SLEEP 114768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // 0 114868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1149543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if ( (HCF_TYPE) & HCF_TYPE_PRELOADED ) == 0 //switch clock back for SEEPROM access !!! 1150543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OUT_PORT_WORD( io_addr + HREG_CMD, HCMD_INI ); //OPW not yet useable 115168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot prot_cnt = INI_TICK_INI; 115268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( (IN_PORT_WORD( io_addr + HREG_EV_STAT) & HREG_EV_CMD) == 0 ); 1153543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OUT_PORT_WORD( (io_addr + HREG_IO), HREG_IO_SRESET ); //OPW not yet useable /* 2a*/ 115468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_PRELOADED 1155543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy for ( q = (hcf_8*)(&ifbp->IFB_Magic); q > (hcf_8*)ifbp; *--q = 0 ) /*NOP*/; /* 4 */ 1156543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_Magic = HCF_MAGIC; 1157543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_Version = IFB_VERSION; 115868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if defined MSF_COMPONENT_ID //a new IFB demonstrates how dirty the solution is 1159543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy xxxx[xxxx_PRI_IDENTITY_OFFSET] = NULL; //IFB_PRIIdentity placeholder 0xFD02 1160543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy xxxx[xxxx_PRI_IDENTITY_OFFSET+1] = NULL; //IFB_PRISup placeholder 0xFD03 116168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // MSF_COMPONENT_ID 116268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TALLIES) & ( HCF_TALLIES_NIC | HCF_TALLIES_HCF ) 1163543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TallyLen = 1 + 2 * (HCF_NIC_TAL_CNT + HCF_HCF_TAL_CNT); //convert # of Tallies to L value for LTV 1164543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TallyTyp = CFG_TALLIES; //IFB_TallyTyp: set T value 116568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TALLIES_NIC / HCF_TALLIES_HCF 1166543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_IOBase = io_addr; //set IO_Base asap, so asserts via HREG_SW_2 don't harm 1167543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_IORange = HREG_IO_RANGE; 1168543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CntlOpt = USE_16BIT; 116968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 117068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot assert_ifbp = ifbp; 117168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertLvl = 1; 117268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_LNK_MSF_RTN 117368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( io_base != HCF_DISCONNECT ) { 1174543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_AssertRtn = (MSF_ASSERT_RTNP)msf_assert; /* 6 */ 117568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 117668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_LNK_MSF_RTN 1177543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if (HCF_ASSERT) & HCF_ASSERT_MB //build the structure to pass the assert info to hcf_put_info 117868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.len = sizeof(ifbp->IFB_AssertStrct)/sizeof(hcf_16) - 1; 117968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.typ = CFG_MB_INFO; 118068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.base_typ = CFG_MB_ASSERT; 118168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.frag_cnt = 1; 118268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.frag_buf[0].frag_len = 118368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ( offsetof(IFB_STRCT, IFB_AssertLvl) - offsetof(IFB_STRCT, IFB_AssertLine) ) / sizeof(hcf_16); 118468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertStrct.frag_buf[0].frag_addr = &ifbp->IFB_AssertLine; 118568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_MB 118668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 1187788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( prot_cnt = ifbp->IFB_TickIni = INI_TICK_INI ); 118868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_PRELOADED ) == 0 118968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //!! No asserts before Reset-bit in HREG_IO is cleared 1190543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_IO, 0x0000 ); //OPW useable /* 2b*/ 119168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( (IPW( HREG_EV_STAT) & HREG_EV_CMD) == 0 ); 1192788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( HCFASSERT( prot_cnt, IPW( HREG_EV_STAT) ) ); 1193788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( if ( prot_cnt ) prot_cnt = ifbp->IFB_TickIni ); 119468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_PRELOADED 119568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //!! No asserts before Reset-bit in HREG_IO is cleared 1196543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( DO_ASSERT, MERGE_2( HCF_ASSERT, 0xCAF0 ) ); //just to proof that the complete assert machinery is working 1197543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( xa != CFG_FW_IDENTITY, 0 ); // assert if hcf_connect is called without intervening hcf_disconnect. 1198788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)(void*)ifbp & (HCF_ALIGN-1) ) == 0, (hcf_32)(void*)ifbp ); 1199788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (io_addr & 0x003F) == 0, io_addr ); 1200543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if Busy bit in Cmd register 1201543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if (IPW( HREG_CMD ) & HCMD_BUSY ) { /* 8 */ 1202543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. Ack all to unblock a (possibly) blocked cmd pipe line 120368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_EV_ACK, ~HREG_EV_SLEEP_REQ ); 1204543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. Wait for Busy bit drop in Cmd register 1205543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. Wait for Cmd bit raise in Ev register 120668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( ( IPW( HREG_CMD ) & HCMD_BUSY ) && (IPW( HREG_EV_STAT) & HREG_EV_CMD) == 0 ); 1207788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( HCFASSERT( prot_cnt, IPW( HREG_EV_STAT) ) ); /* if prot_cnt == 0, cmd_exe will fail, causing DEFUNCT */ 120868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 120968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_EV_ACK, ~HREG_EV_SLEEP_REQ ); 1210543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if ( (HCF_TYPE) & HCF_TYPE_PRELOADED ) == 0 /*12*/ 121168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)cmd_exe( ifbp, HCMD_INI, 0 ); 121268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_PRELOADED 1213543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( io_base != HCF_DISCONNECT ) { 1214543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = init( ifbp ); /*14*/ 121568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( rc == HCF_SUCCESS ) { 121668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.len = 2; 121768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.typ = CFG_NIC_BUS_TYPE; 121868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)hcf_get_info( ifbp, &x ); 121968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_BusType = x.val[0]; 122068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //CFG_NIC_BUS_TYPE not supported -> default 32 bits/DMA, MSF has to overrule via CFG_CNTL_OPT 122168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( x.len == 0 || x.val[0] == 0x0002 || x.val[0] == 0x0003 ) { 122268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_IO) & HCF_IO_32BITS 1223543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CntlOpt &= ~USE_16BIT; //reset USE_16BIT 122468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_IO_32BITS 122568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 1226543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CntlOpt |= USE_DMA; //SET DMA 122768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 122868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_IORange = 0x40 /*i.s.o. HREG_IO_RANGE*/; 122968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 123068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 123168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 123268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else HCFASSERT( ( ifbp->IFB_Magic ^= HCF_MAGIC ) == 0, ifbp->IFB_Magic ) /*NOP*/; 123368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* of above HCFASSERT only the side effect is needed, NOP in case HCFASSERT is dummy */ 1234543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_IOBase = io_base; /* 0*/ 123568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 123668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_connect 123768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 123868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 123968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1240543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Function get_frame_lst 1241543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - resolve the "last host-owned descriptor" problems when a descriptor list is reclaimed by the MSF. 1242543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1243543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The FrameList to be reclaimed as well as the DescriptorList always start in IFB_FirstDesc[tx_rx_flag] 1244543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and this is always the "current" DELWA Descriptor. 1245543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1246543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If a FrameList is available, the last descriptor of the FrameList to turned into a new DELWA Descriptor: 1247543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a copy is made from the information in the last descriptor of the FrameList into the current 1248543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DELWA Descriptor 1249543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the remainder of the DescriptorList is detached from the copy by setting the next_desc_addr at NULL 1250543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DMA control bits of the copy are cleared to do not confuse the MSF 1251543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the copy of the last descriptor (i.e. the "old" DELWA Descriptor) is chained to the prev Descriptor 1252543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of the FrameList, thus replacing the original last Descriptor of the FrameList. 1253543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_FirstDesc is changed to the address of that replaced (original) last descriptor of the FrameList, 1254543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * i.e. the "new" DELWA Descriptor. 1255543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1256543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This function makes a copy of that last host-owned descriptor, so the MSF will get a copy of the descriptor. 1257543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On top of that, it adjusts DMA related fields in the IFB structure. 1258543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // perform a copying-scheme to circumvent the 'last host owned descriptor cannot be reclaimed' limitation imposed by H2.5's DMA hardware design 1259543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // a 'reclaim descriptor' should be available in the HCF: 1260543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1261543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Returns: address of the first descriptor of the FrameList 1262543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 126368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 8: Be careful once you start re-ordering the steps in the copy process, that it still works for cases 1264543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of FrameLists of 1, 2 and more than 2 descriptors 1265543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1266543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Input parameters: 1267543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * tx_rx_flag : specifies 'transmit' or 'receive' descriptor. 1268543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1269543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 127068c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC DESC_STRCT* 127168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootget_frame_lst( IFBP ifbp, int tx_rx_flag ) 127268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 127368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1274543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *head = ifbp->IFB_FirstDesc[tx_rx_flag]; 1275543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *copy, *p, *prev; 127668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1277788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( tx_rx_flag == DMA_RX || tx_rx_flag == DMA_TX, tx_rx_flag ); 1278543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if FrameList 127968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( head ) { 1280543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. search for last descriptor of first FrameList 128168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = prev = head; 128268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( ( p->BUF_SIZE & DESC_EOP ) == 0 && p->next_desc_addr ) { 1283543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( ifbp->IFB_CntlOpt & DMA_ENABLED ) == 0 ) { //clear control bits when disabled 128468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->BUF_CNT &= DESC_CNT_MASK; 128568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 128668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot prev = p; 128768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = p->next_desc_addr; 128868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 1289543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if DMA enabled 129068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_CntlOpt & DMA_ENABLED ) { 1291543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . if last descriptor of FrameList is DMA owned 1292543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . or if FrameList is single (DELWA) Descriptor 129368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( p->BUF_CNT & DESC_DMA_OWNED || head->next_desc_addr == NULL ) { 1294543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . refuse to return FrameList to caller 129568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot head = NULL; 129668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 129768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 129868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 1299543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if returnable FrameList found 130068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( head ) { 1301543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if FrameList is single (DELWA) Descriptor (implies DMA disabled) 1302543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( head->next_desc_addr == NULL ) { 1303543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . clear DescriptorList 130468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /*;?ifbp->IFB_LastDesc[tx_rx_flag] =*/ ifbp->IFB_FirstDesc[tx_rx_flag] = NULL; 1305543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. else 130668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 1307543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . strip hardware-related bits from last descriptor 1308543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . remove DELWA Descriptor from head of DescriptorList 130968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy = head; 1310543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy head = head->next_desc_addr; 1311543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . exchange first (Confined) and last (possibly imprisoned) Descriptor 131268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy->buf_phys_addr = p->buf_phys_addr; 131368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy->buf_addr = p->buf_addr; 1314543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy copy->BUF_SIZE = p->BUF_SIZE &= DESC_CNT_MASK; //get rid of DESC_EOP and possibly DESC_SOP 1315543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy copy->BUF_CNT = p->BUF_CNT &= DESC_CNT_MASK; //get rid of DESC_DMA_OWNED 131668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_DESC_STRCT_EXT 131768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy->DESC_MSFSup = p->DESC_MSFSup; 131868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DESC_STRCT_EXT 1319543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . turn into a DELWA Descriptor 132068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->buf_addr = NULL; 1321543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . chain copy to prev /* 8*/ 132268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot prev->next_desc_addr = copy; 1323543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . detach remainder of the DescriptorList from FrameList 132468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy->next_desc_addr = NULL; 132568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot copy->next_desc_phys_addr = 0xDEAD0000; //! just to be nice, not really needed 1326543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . save the new start (i.e. DELWA Descriptor) in IFB_FirstDesc 132768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FirstDesc[tx_rx_flag] = p; 132868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 1329543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. strip DESC_SOP from first descriptor 133068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot head->BUF_SIZE &= DESC_CNT_MASK; 133168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //head->BUF_CNT &= DESC_CNT_MASK; get rid of DESC_DMA_OWNED 133268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot head->next_desc_phys_addr = 0xDEAD0000; //! just to be nice, not really needed 133368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 1334543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //return the just detached FrameList (if any) 133568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return head; 133668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // get_frame_lst 133768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 133868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 133968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1340543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Function put_frame_lst 1341543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1342543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This function 1343543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1344543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Returns: address of the first descriptor of the FrameList 1345543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1346543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Input parameters: 1347543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * tx_rx_flag : specifies 'transmit' or 'receive' descriptor. 1348543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1349543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The following list should be kept in sync with hcf_dma_tx/rx_put, in order to get them in the WCI-spec !!!! 1350543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 1351543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - DMA is not enabled 1352543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - descriptor list is NULL 1353543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a descriptor in the descriptor list is not double word aligned 1354543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a count of size field of a descriptor contains control bits, i.e. bits in the high order nibble. 1355543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not a "singleton" DescriptorList. 1356543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not the first Descriptor supplied 1357543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a non_DMA descriptor is supplied before the DELWA Descriptor is supplied 1358543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Possibly more checks could be added !!!!!!!!!!!!! 1359543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 1360543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1361543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The asserts marked with *sc* are really sanity checks for the HCF, they can (supposedly) not be influenced 1362543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * by incorrect MSF behavior 1363543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 1364543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // The MSF is required to supply the HCF with a single descriptor for MSF tx reclaim purposes. 1365543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // This 'reclaim descriptor' can be recognized by the fact that its buf_addr field is zero. 1366543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ********************************************************************************************* 1367543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Although not required from a hardware perspective: 1368543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - make each descriptor in this rx-chain DMA-owned. 1369543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Also set the count to zero. EOP and SOP bits are also cleared. 1370543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *********************************************************************************************/ 137168c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 137268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootput_frame_lst( IFBP ifbp, DESC_STRCT *descp, int tx_rx_flag ) 137368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 1374543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *p = descp; 137568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_16 port; 137668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1377788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_CntlOpt & USE_DMA, ifbp->IFB_CntlOpt); //only hcf_dma_tx_put must also be DMA_ENABLED 1378788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( tx_rx_flag == DMA_RX || tx_rx_flag == DMA_TX, tx_rx_flag ); 1379788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( p , 0 ); 138068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 138168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( p ) { 1382788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)p & 3 ) == 0, (hcf_32)p ); 1383788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (p->BUF_CNT & ~DESC_CNT_MASK) == 0, p->BUF_CNT ); 1384788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (p->BUF_SIZE & ~DESC_CNT_MASK) == 0, p->BUF_SIZE ); 1385543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy p->BUF_SIZE &= DESC_CNT_MASK; //!!this SHOULD be superfluous in case of correct MSF 1386543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy p->BUF_CNT &= tx_rx_flag == DMA_RX ? 0 : DESC_CNT_MASK; //!!this SHOULD be superfluous in case of correct MSF 138768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->BUF_CNT |= DESC_DMA_OWNED; 138868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( p->next_desc_addr ) { 1389788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy// HCFASSERT( p->buf_addr && p->buf_phys_addr && p->BUF_SIZE && +/- p->BUF_SIZE, ... ); 1390788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( p->next_desc_addr->desc_phys_addr, (hcf_32)p->next_desc_addr ); 139168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->next_desc_phys_addr = p->next_desc_addr->desc_phys_addr; 1392543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else { // 139368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p->next_desc_phys_addr = 0; 1394543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( p->buf_addr == NULL ) { // DELWA Descriptor 1395543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( descp == p, (hcf_32)descp ); //singleton DescriptorList 1396788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_FirstDesc[tx_rx_flag] == NULL, (hcf_32)ifbp->IFB_FirstDesc[tx_rx_flag]); 1397788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_LastDesc[tx_rx_flag] == NULL, (hcf_32)ifbp->IFB_LastDesc[tx_rx_flag]); 139868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp->BUF_CNT = 0; //&= ~DESC_DMA_OWNED; 139968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FirstDesc[tx_rx_flag] = descp; 140068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// part of alternative ifbp->IFB_LastDesc[tx_rx_flag] = ifbp->IFB_FirstDesc[tx_rx_flag] = descp; 1401543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // if "recycling" a FrameList 1402543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // (e.g. called from hcf_cntl( HCF_CNTL_ENABLE ) 1403543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // . prepare for activation DMA controller 140468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// part of alternative descp = descp->next_desc_addr; 1405543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else { //a "real" FrameList, hand it over to the DMA engine 1406788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_FirstDesc[tx_rx_flag], (hcf_32)descp ); 1407788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_LastDesc[tx_rx_flag], (hcf_32)descp ); 140868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFASSERT( ifbp->IFB_LastDesc[tx_rx_flag]->next_desc_addr == NULL, 1409543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (hcf_32)ifbp->IFB_LastDesc[tx_rx_flag]->next_desc_addr); 141068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// p->buf_cntl.cntl_stat |= DESC_DMA_OWNED; 141168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_LastDesc[tx_rx_flag]->next_desc_addr = descp; 141268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_LastDesc[tx_rx_flag]->next_desc_phys_addr = descp->desc_phys_addr; 141368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot port = HREG_RXDMA_PTR32; 141468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( tx_rx_flag ) { 1415543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy p->BUF_SIZE |= DESC_EOP; // p points at the last descriptor in the caller-supplied descriptor chain 141668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp->BUF_SIZE |= DESC_SOP; 141768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot port = HREG_TXDMA_PTR32; 141868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 141968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_DWORD( (ifbp->IFB_IOBase + port), descp->desc_phys_addr ); 142068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 142168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_LastDesc[tx_rx_flag] = p; 142268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 142368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = p->next_desc_addr; 142468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 142568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // put_frame_lst 142668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 142768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 142868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1429543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1430543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE DESC_STRCT* hcf_dma_rx_get( IFBP ifbp ) 1431543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE decapsulate a message and provides that message to the MSF. 1432543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * reclaim all descriptors in the rx descriptor chain. 1433543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1434543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1435543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 1436543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1437543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 1438543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pointer to a FrameList 1439543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1440543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1441543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_dma_rx_get is intended to return a received frame when such a frame is deposited in Host memory by the 1442543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * DMA engine. In addition hcf_dma_rx_get can be used to reclaim all descriptors in the rx descriptor chain 1443543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * when the DMA Engine is disabled, e.g. as part of a driver unloading strategy. 1444543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_dma_rx_get must be called repeatedly by the MSF when hcf_service_nic signals availability of a rx frame 1445543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * through the HREG_EV_RDMAD flag of IFB_DmaPackets. The calling must stop when a NULL pointer is returned, at 1446543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * which time the HREG_EV_RDMAD flag is also cleared by the HCF to arm the mechanism for the next frame 1447543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * reception. 1448543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Regardless whether the DMA Engine is currently enabled (as controlled via hcf_cntl), if the DMA controller 1449543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * deposited an Rx-frame in the Rx-DescriptorList, this frame is detached from the Rx-DescriptorList, 1450543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * transformed into a FrameList (i.e. updating the housekeeping fields in the descriptors) and returned to the 1451543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * caller. 1452543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If no such Rx-frame is available in the Rx-DescriptorList, the behavior of hcf_dma_rx_get depends on the 1453543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * status of the DMA Engine. 1454543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the DMA Engine is enabled, a NULL pointer is returned. 1455543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the DMA Engine is disabled, the following strategy is used: 1456543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the complete Rx-DescriptorList is returned. The DELWA Descriptor is not part of the Rx-DescriptorList. 1457543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - If there is no Rx-DescriptorList, the DELWA Descriptor is returned. 1458543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - If there is no DELWA Descriptor, a NULL pointer is returned. 1459543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1460543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the MSF performs an disable/enable sequence without exhausting the Rx-DescriptorList as described above, 1461543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the enable command will reset all house keeping information, i.e. already received but not yet by the MSF 1462543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * retrieved frames are lost and the next frame will be received starting with the oldest descriptor. 1463543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1464543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF can be used in 2 fashions: with and without decapsulation for data transfer. 1465543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This is controlled at compile time by the HCF_ENC bit of the HCF_ENCAP system constant. 1466543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If appropriate, decapsulation is done by moving some data inside the buffers and updating the descriptors 1467543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * accordingly. 1468543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! ;?????where did I describe why a simple manipulation with the count values does not suffice? 1469543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1470543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1471543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1472543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1473543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1474543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 147568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 147668c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootDESC_STRCT* 147768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_dma_rx_get (IFBP ifbp) 147868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 1479543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *descp; // pointer to start of FrameList 148068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 148168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp = get_frame_lst( ifbp, DMA_RX ); 148289c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( descp && descp->buf_addr ) { 148368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1484543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //skip decapsulation at confined descriptor 148568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ENCAP) == HCF_ENC 148689c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy int i; 148789c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy DESC_STRCT *p = descp->next_desc_addr; //pointer to 2nd descriptor of frame 148889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy HCFASSERT(p, 0); 148989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // The 2nd descriptor contains (maybe) a SNAP header plus part or whole of the payload. 149089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy //determine decapsulation sub-flag in RxFS 149189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy i = *(wci_recordp)&descp->buf_addr[HFS_STAT] & ( HFS_STAT_MSG_TYPE | HFS_STAT_ERR ); 149289c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( i == HFS_STAT_TUNNEL || 149389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy ( i == HFS_STAT_1042 && hcf_encap( (wci_bufp)&p->buf_addr[HCF_DASA_SIZE] ) != ENC_TUNNEL )) { 149489c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // The 2nd descriptor contains a SNAP header plus part or whole of the payload. 149589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy HCFASSERT( p->BUF_CNT == (p->buf_addr[5] + (p->buf_addr[4]<<8) + 2*6 + 2 - 8), p->BUF_CNT ); 149689c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // perform decapsulation 149789c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy HCFASSERT(p->BUF_SIZE >=8, p->BUF_SIZE); 149889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // move SA[2:5] in the second buffer to replace part of the SNAP header 149989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy for ( i=3; i >= 0; i--) p->buf_addr[i+8] = p->buf_addr[i]; 150089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // copy DA[0:5], SA[0:1] from first buffer to second buffer 150189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy for ( i=0; i<8; i++) p->buf_addr[i] = descp->buf_addr[HFS_ADDR_DEST + i]; 150289c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // make first buffer shorter in count 150389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->BUF_CNT = HFS_ADDR_DEST; 150468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 150589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy } 150668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ENC 150768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( descp == NULL ) ifbp->IFB_DmaPackets &= (hcf_16)~HREG_EV_RDMAD; //;?could be integrated into get_frame_lst 1508788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_DMA_RX_GET ); 150968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return descp; 151068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_dma_rx_get 151168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 151268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 151368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1514543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1515543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE void hcf_dma_rx_put( IFBP ifbp, DESC_STRCT *descp ) 1516543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE supply buffers for receive purposes. 1517543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * supply the Rx-DELWA descriptor. 1518543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1519543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1520543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 1521543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descp address of a DescriptorList 1522543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1523543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 1524543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1525543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1526543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This function is called by the MSF to supply the HCF with new/more buffers for receive purposes. 1527543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF can be used in 2 fashions: with and without encapsulation for data transfer. 1528543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This is controlled at compile time by the HCF_ENC bit of the HCF_ENCAP system constant. 1529543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * As a consequence, some additional constraints apply to the number of descriptor and the buffers associated 1530543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * with the first 2 descriptors. Independent of the encapsulation feature, the COUNT fields are ignored. 1531543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * A special case is the supplying of the DELWA descriptor, which must be supplied as the first descriptor. 1532543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1533543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 1534543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 1535543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - NIC interrupts are not disabled while required by parameter action. 1536543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case decapsulation by the HCF is selected: 1537543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The first databuffer does not have the exact size corresponding with the RxFS up to the 802.3 DestAddr 1538543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * field (== 29 words). 1539543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The FrameList does not consists of at least 2 Descriptors. 1540543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The second databuffer does not have the minimum size of 8 bytes. 1541543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! The 2nd part of the list of asserts should be kept in sync with put_frame_lst, in order to get 1542543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! them in the WCI-spec !!!! 1543543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - DMA is not enabled 1544543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - descriptor list is NULL 1545543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a descriptor in the descriptor list is not double word aligned 1546543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a count of size field of a descriptor contains control bits, i.e. bits in the high order nibble. 1547543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not a "singleton" DescriptorList. 1548543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not the first Descriptor supplied 1549543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a non_DMA descriptor is supplied before the DELWA Descriptor is supplied 1550543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! - Possibly more checks could be added !!!!!!!!!!!!! 1551543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1552543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1553543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1554543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1555543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1556543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1557543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 155868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 155968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_dma_rx_put( IFBP ifbp, DESC_STRCT *descp ) 156068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 156168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1562788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_DMA_RX_PUT, 0xDA01 ); 1563788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 1564788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 156568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 156668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frame_lst( ifbp, descp, DMA_RX ); 156768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT && (HCF_ENCAP) == HCF_ENC 156868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( descp->buf_addr ) { 1569788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( descp->BUF_SIZE == HCF_DMA_RX_BUF1_SIZE, descp->BUF_SIZE ); 1570788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( descp->next_desc_addr, 0 ); // first descriptor should be followed by another descriptor 157168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // The second DB is for SNAP and payload purposes. It should be a minimum of 12 bytes in size. 1572788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( descp->next_desc_addr->BUF_SIZE >= 12, descp->next_desc_addr->BUF_SIZE ); 157368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 157468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCFASSERT / HCF_ENC 1575788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_DMA_RX_PUT ); 157668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_dma_rx_put 157768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 157868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 157968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1580543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1581543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE DESC_STRCT* hcf_dma_tx_get( IFBP ifbp ) 1582543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE DMA mode: reclaims and decapsulates packets in the tx descriptor chain if: 1583543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - A Tx packet has been copied from host-RAM into NIC-RAM by the DMA engine 1584543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The Hermes/DMAengine have been disabled 1585543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1586543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1587543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 1588543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1589543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 1590543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pointer to a reclaimed Tx packet. 1591543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1592543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1593543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * impact of the disable command: 1594543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When a non-empty pool of Tx descriptors exists (created by means of hcf_dma_put_tx), the MSF 1595543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is supposed to empty that pool by means of hcf_dma_tx_get calls after the disable in an 1596543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * disable/enable sequence. 1597543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1598543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1599543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1600543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1601543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1602543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1603543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1604543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 160568c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootDESC_STRCT* 160668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_dma_tx_get( IFBP ifbp ) 160768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 1608543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *descp; // pointer to start of FrameList 160968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 161068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp = get_frame_lst( ifbp, DMA_TX ); 161189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( descp && descp->buf_addr ) { 1612543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //skip decapsulation at confined descriptor 161368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ENCAP) == HCF_ENC 161489c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( ( descp->BUF_CNT == HFS_TYPE )) { 161589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy // perform decapsulation if needed 161668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp->next_desc_addr->buf_phys_addr -= HCF_DASA_SIZE; 1617543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy descp->next_desc_addr->BUF_CNT += HCF_DASA_SIZE; 161868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 161968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ENC 162089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy } 162168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( descp == NULL ) { //;?could be integrated into get_frame_lst 162268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_DmaPackets &= (hcf_16)~HREG_EV_TDMAD; 162368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 1624788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_DMA_TX_GET ); 162568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return descp; 162668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_dma_tx_get 162768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 162868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 162968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1630543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1631543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE void hcf_dma_tx_put( IFBP ifbp, DESC_STRCT *descp, hcf_16 tx_cntl ) 1632543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE puts a packet in the Tx DMA queue in host ram and kicks off the TxDma engine. 1633543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * supply the Tx-DELWA descriptor. 1634543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1635543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1636543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 1637543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descp address of Tx Descriptor Chain (i.e. a single Tx frame) 1638543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * tx_cntl indicates MAC-port and (Hermes) options 1639543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1640543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 1641543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1642543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1643543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF can be used in 2 fashions: with and without encapsulation for data transfer. 1644543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This is controlled at compile time by the HCF_ENC bit of the HCF_ENCAP system constant. 1645543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1646543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Regardless of the HCF_ENCAP system constant, the descriptor list created to describe the frame to be 1647543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * transmitted, must supply space to contain the 802.11 header, preceding the actual frame to be transmitted. 1648543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Basically, this only supplies working storage to the HCF which passes this on to the DMA engine. 1649543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * As a consequence the contents of this space do not matter. 1650543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Nevertheless BUF_CNT must take in account this storage. 1651543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This working space to contain the 802.11 header may not be fragmented, the first buffer must be 1652543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * sufficiently large to contain at least the 802.11 header, i.e. HFS_ADDR_DEST (29 words or 0x3A bytes). 1653543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This way, the HCF can simply, regardless whether or not the HCF encapsulates the frame, write the parameter 1654543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * tx_cntl at offset 0x36 (HFS_TX_CNTL) in the first buffer. 1655543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that it is allowed to have part or all of the actual frame represented by the first descriptor as long 1656543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * as the requirement for storage for the 802.11 header is met, i.e. the 802.3 frame starts at offset 1657543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_ADDR_DEST. 1658543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Except for the Assert on the 1st buffer in case of Encapsualtion, the SIZE fields are ignored. 1659543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1660543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case the encapsulation feature is compiled in, there are the following additional requirements. 1661543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o The BUF_CNT of the first buffer changes from a minimum of 0x3A bytes to exactly 0x3A, i.e. the workspace 1662543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to store the 802.11 header 1663543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o The BUF_SIZE of the first buffer is at least the space needed to store the 1664543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - 802.11 header (29 words) 1665543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - 802.3 header, i.e. 12 bytes addressing information and 2 bytes length field 1666543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - 6 bytes SNAP-header 1667543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This results in 39 words or 0x4E bytes or HFS_TYPE. 1668543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that if the BUF_SIZE is larger than 0x4E, this surplus is not used. 1669543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o The actual frame begins in the 2nd descriptor (which is already implied by the BUF_CNT == 0x3A requirement) and the associated buffer contains at least the 802.3 header, i.e. the 14 bytes representing addressing information and length/type field 1670543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1671543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When the HCF does not encapsulates (i.e. length/type field <= 1500), no changes are made to descriptors 1672543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * or buffers. 1673543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1674543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When the HCF actually encapsulates (i.e. length/type field > 1500), it successively writes, starting at 1675543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * offset HFS_ADDR_DEST (0x3A) in the first buffer: 1676543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the 802.3 addressing information, copied from the begin of the second buffer 1677543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the frame length, derived from the total length of the individual fragments, corrected for the SNAP 1678543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * header length and Type field and ignoring the Destination Address, Source Address and Length field 1679543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the appropriate snap header (Tunnel or 1042, depending on the value of the type field). 1680543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1681543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The information in the first two descriptors is adjusted accordingly: 1682543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the first descriptor count is changed from 0x3A to 0x4E (HFS_TYPE), which matches 0x3A + 12 + 2 + 6 1683543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the second descriptor count is decreased by 12, being the moved addressing information 1684543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the second descriptor (physical) buffer address is increased by 12. 1685543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1686543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When the descriptors are returned by hcf_dma_tx_get, the transformation of the first two descriptors is 1687543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * undone. 1688543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1689543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Under any of the above scenarios, the assert BUF_CNT <= BUF_SIZE must be true for all descriptors 1690543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of encapsulation, BUF_SIZE of the 1st descriptor is asserted to be at least HFS_TYPE (0x4E), so it is NOT tested. 1691543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1692543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 1693543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 1694543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - tx_cntl has a recognizable out-of-range value. 1695543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - NIC interrupts are not disabled while required by parameter action. 1696543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case encapsulation by the HCF is selected: 1697543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The FrameList does not consists of at least 2 Descriptors. 1698543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The first databuffer does not contain exactly the (space for) the 802.11 header (== 28 words) 1699543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The first databuffer does not have a size to additionally accommodate the 802.3 header and the 1700543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * SNAP header of the frame after encapsulation (== 39 words). 1701543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - The second databuffer does not contain at least DA, SA and 'type/length' (==14 bytes or 7 words) 1702543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! The 2nd part of the list of asserts should be kept in sync with put_frame_lst, in order to get 1703543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! them in the WCI-spec !!!! 1704543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - DMA is not enabled 1705543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - descriptor list is NULL 1706543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a descriptor in the descriptor list is not double word aligned 1707543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a count of size field of a descriptor contains control bits, i.e. bits in the high order nibble. 1708543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not a "singleton" DescriptorList. 1709543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the DELWA descriptor is not the first Descriptor supplied 1710543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a non_DMA descriptor is supplied before the DELWA Descriptor is supplied 1711543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! - Possibly more checks could be added !!!!!!!!!!!!! 1712543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1713543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1714543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1715543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1716543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1717543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1718543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1719543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: Write tx_cntl parameter to HFS_TX_CNTL field into the Hermes-specific header in buffer 1 1720543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: determine whether encapsulation is needed and write the type (tunnel or 1042) already at the appropriate 1721543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * offset in the 1st buffer 1722543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: Build the encapsualtion enveloppe in the free space at the end of the 1st buffer 1723543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Copy DA/SA fields from the 2nd buffer 1724543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Calculate total length of the message (snap-header + type-field + the length of all buffer fragments 1725543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * associated with the 802.3 frame (i.e all descriptors except the first), but not the DestinationAddress, 1726543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * SourceAddress and length-field) 1727543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert the message length 1728543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Write length. Note that the message is in BE format, hence on LE platforms the length must be converted 1729543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ;? THIS IS NOT WHAT CURRENTLY IS IMPLEMENTED 1730543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Write snap header. Note that the last byte of the snap header is NOT copied, that byte is already in 1731543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * place as result of the call to hcf_encap. 1732543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that there are many ways to skin a cat. To express the offsets in the 1st buffer while writing 1733543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the snap header, HFS_TYPE is chosen as a reference point to make it easier to grasp that the snap header 1734543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and encapsualtion type are at least relative in the right. 1735543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: modify 1st descriptor to reflect moved part of the 802.3 header + Snap-header 1736543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * modify 2nd descriptor to skip the moved part of the 802.3 header (DA/SA 1737543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *10: set each descriptor to 'DMA owned', clear all other control bits. 1738543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Set SOP bit on first descriptor. Set EOP bit on last descriptor. 1739543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *12: Either append the current frame to an existing descriptor list or 1740543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *14: create a list beginning with the current frame 1741543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *16: remember the new end of the list 1742543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *20: hand the frame over to the DMA engine 1743543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 174468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 174568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_dma_tx_put( IFBP ifbp, DESC_STRCT *descp, hcf_16 tx_cntl ) 174668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 1747543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *p = descp->next_desc_addr; 1748543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i; 174968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 175068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 175168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot int x = ifbp->IFB_FWIdentity.comp_id == COMP_ID_FW_AP ? tx_cntl & ~HFS_TX_CNTL_PORT : tx_cntl; 1752788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (x & ~HCF_TX_CNTL_MASK ) == 0, tx_cntl ); 175368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 1754788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_DMA_TX_PUT, 0xDA03 ); 1755788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 1756788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 1757788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ( ifbp->IFB_CntlOpt & (USE_DMA|DMA_ENABLED) ) == (USE_DMA|DMA_ENABLED), ifbp->IFB_CntlOpt); 175868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 175968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( descp->buf_addr ) { 1760543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *(hcf_16*)(descp->buf_addr + HFS_TX_CNTL) = tx_cntl; /*1*/ 176168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ENCAP) == HCF_ENC 1762543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( descp->next_desc_addr, 0 ); //at least 2 descripors 1763543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( descp->BUF_CNT == HFS_ADDR_DEST, descp->BUF_CNT ); //exact length required for 1st buffer 1764543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( descp->BUF_SIZE >= HCF_DMA_TX_BUF1_SIZE, descp->BUF_SIZE ); //minimal storage for encapsulation 1765543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( p->BUF_CNT >= 14, p->BUF_CNT ); //at least DA, SA and 'type' in 2nd buffer 176668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 176789c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->buf_addr[HFS_TYPE-1] = hcf_encap(&descp->next_desc_addr->buf_addr[HCF_DASA_SIZE]); /*4*/ 176889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( descp->buf_addr[HFS_TYPE-1] != ENC_NONE ) { 176989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy for ( i=0; i < HCF_DASA_SIZE; i++ ) { /*6*/ 177089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->buf_addr[i + HFS_ADDR_DEST] = descp->next_desc_addr->buf_addr[i]; 177168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 177289c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy i = sizeof(snap_header) + 2 - ( 2*6 + 2 ); 177389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy do { i += p->BUF_CNT; } while ( ( p = p->next_desc_addr ) != NULL ); 177489c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy *(hcf_16*)(&descp->buf_addr[HFS_LEN]) = CNV_END_SHORT(i); //!! this converts on ALL platforms, how does that relate to the CCX code 177589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy for ( i=0; i < sizeof(snap_header) - 1; i++) { 177689c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->buf_addr[HFS_TYPE - sizeof(snap_header) + i] = snap_header[i]; 177768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 177889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->BUF_CNT = HFS_TYPE; /*8*/ 177989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->next_desc_addr->buf_phys_addr += HCF_DASA_SIZE; 178089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy descp->next_desc_addr->BUF_CNT -= HCF_DASA_SIZE; 178168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 178268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ENC 1783543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 178468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frame_lst( ifbp, descp, DMA_TX ); 1785788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_DMA_TX_PUT ); 178668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_dma_tx_put 178768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 178868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 178968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 179068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1791543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1792543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE hcf_8 hcf_encap( wci_bufp type ) 1793543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE test whether RFC1042 or Bridge-Tunnel encapsulation is needed. 1794543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1795543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1796543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * type (Far) pointer to the (Big Endian) Type/Length field in the message 1797543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1798543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 1799543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ENC_NONE len/type is "len" ( (BIG_ENDIAN)type <= 1500 ) 1800543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ENC_TUNNEL len/type is "type" and 0x80F3 or 0x8137 1801543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ENC_1042 len/type is "type" but not 0x80F3 or 0x8137 1802543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1803543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.CONDITIONS 1804543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * NIC Interrupts d.c 1805543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1806543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1807543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Type must point to the Len/Type field of the message, this is the 2-byte field immediately after the 6 byte 1808543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Destination Address and 6 byte Source Address. The 2 successive bytes addressed by type are interpreted as 1809543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a Big Endian value. If that value is less than or equal to 1500, the message is assumed to be in 802.3 1810543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * format. Otherwise the message is assumed to be in Ethernet-II format. Depending on the value of Len/Typ, 1811543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Bridge Tunnel or RFC1042 encapsulation is needed. 1812543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1813543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1814543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1815543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1: presume 802.3, hence preset return value at ENC_NONE 1816543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2: convert type from "network" Endian format to native Endian 1817543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4: the litmus test to distinguish type and len. 1818543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The hard code "magic" value of 1500 is intentional and should NOT be replaced by a mnemonic because it is 1819543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * not related at all to the maximum frame size supported by the Hermes. 1820543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 6: check type against: 1821543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0x80F3 //AppleTalk Address Resolution Protocol (AARP) 1822543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0x8137 //IPX 1823543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to determine the type of encapsulation 1824543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1825543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1826543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1827543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 182847996398c449092ad882119d49022282bb2c94d4David KilroyHCF_STATIC hcf_8 182968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_encap( wci_bufp type ) 183068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 183168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1832543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_8 rc = ENC_NONE; /* 1 */ 1833543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 t = (hcf_16)(*type<<8) + *(type+1); /* 2 */ 183468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1835543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( t > 1500 ) { /* 4 */ 183668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( t == 0x8137 || t == 0x80F3 ) { 1837543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = ENC_TUNNEL; /* 6 */ 183868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 183968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = ENC_1042; 184068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 184168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 184268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 184368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_encap 184468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 184568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 184668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 1847543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1848543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_get_info( IFBP ifbp, LTVP ltvp ) 1849543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Obtains transient and persistent configuration information from the Card and from the HCF. 1850543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1851543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 1852543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 1853543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ltvp address of LengthTypeValue structure specifying the "what" and the "how much" of the 1854543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * information to be collected from the HCF or from the Hermes 1855543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1856543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 1857543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_LEN The provided buffer was too small 1858543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS Success 1859543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via cmd_exe ( type >= CFG_RID_FW_MIN ) 1860543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC NIC removed during retrieval 1861543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT Expected Hermes event did not occur in expected time 1862543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via cmd_exe and setup_bap (type >= CFG_RID_FW_MIN ) 1863543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_... HCF is in defunct mode (bits 0x7F reflect cause) 1864543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1865543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 1866543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The T-field of the LTV-record (provided by the MSF in parameter ltvp) specifies the RID wanted. The RID 1867543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * information identified by the T-field is copied into the V-field. 1868543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On entry, the L-field specifies the size of the buffer, also called the "Initial DataLength". The L-value 1869543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * includes the size of the T-field, but not the size of the L-field itself. 1870543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On return, the L-field indicates the number of words actually contained by the Type and Value fields. 1871543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * As the size of the Type field in the LTV-record is included in the "Initial DataLength" of the record, the 1872543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * V-field can contain at most "Initial DataLength" - 1 words of data. 1873543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Copying stops if either the complete Information is copied or if the number of words indicated by the 1874543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "Initial DataLength" were copied. The "Initial DataLength" acts as a safe guard against Configuration 1875543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Information blocks that have different sizes for different F/W versions, e.g. when later versions support 1876543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * more tallies than earlier versions. 1877543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the size of Value field of the RID exceeds the size of the "Initial DataLength" -1, as much data 1878543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * as fits is copied, and an error status of HCF_ERR_LEN is returned. 1879543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1880543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * It is the responsibility of the MSF to detect card removal and re-insertion and not call the HCF when the 1881543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * NIC is absent. The MSF cannot, however, timely detect a Card removal if the Card is removed while 1882543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_get_info is in progress. Therefore, the HCF performs its own check on Card presence after the read 1883543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * operation of the NIC data. If the Card is not present or removed during the execution of hcf_get_info, 1884543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC is returned and the content of the Data Buffer is unpredictable. This check is not performed 1885543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in case of the "HCF embedded" pseudo RIDs like CFG_TALLIES. 1886543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1887543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 1888543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 1889543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling hcf_functions without adequate protection 1890543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * against NIC interrupts or multi-threading. 1891543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ltvp is a NULL pointer. 1892543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - length field of the LTV-record at entry is 0 or 1 or has an excessive value (i.e. exceeds HCF_MAX_LTV). 1893543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - type field of the LTV-record is invalid. 1894543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1895543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 1896543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hcf_get_mb_info copies the contents of the oldest MailBox Info block in the MailBox to PC RAM. If len is 1897543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * less than the size of the MailBox Info block, only as much as fits in the PC RAM buffer is copied. After 1898543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the copying the MailBox Read pointer is updated to point to the next MailBox Info block, hence the 1899543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * remainder of an "oversized" MailBox Info block is lost. The truncation of the MailBox Info block is NOT 1900543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * reflected in the return status. Note that hcf_get_info guarantees the length of the PC RAM buffer meets 1901543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the minimum requirements of at least 2, so no PC RAM buffer overrun. 1902543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1903543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Calling hcf_get_mb_info when their is no MailBox Info block available or when there is no MailBox at all, 1904543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * results in a "NULL" MailBox Info block. 1905543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1906543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *12: see NOTICE 1907543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *17: The return status of cmd_wait and the first hcfio_in_string can be ignored, because when one fails, the 1908543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * other fails via the IFB_DefunctStat mechanism 1909543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *20: "HCFASSERT( rc == HCF_SUCCESS, rc )" is not suitable because this will always trigger as side effect of 1910543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the HCFASSERT in hcf_put_info which calls hcf_get_info to figure out whether the RID exists at all. 191168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1912543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 1913543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1914543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "HCF embedded" pseudo RIDs: 1915543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * CFG_MB_INFO, CFG_TALLIES, CFG_DRV_IDENTITY, CFG_DRV_SUP_RANGE, CFG_DRV_ACT_RANGES_PRI, 1916543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * CFG_DRV_ACT_RANGES_STA, CFG_DRV_ACT_RANGES_HSI 1917543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note the HCF_ERR_LEN is NOT adequately set, when L >= 2 but less than needed 1918543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1919543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Remarks: Transfers operation information and transient and persistent configuration information from the 1920543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Card and from the HCF to the MSF. 1921543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The exact layout of the provided data structure depends on the action code. Copying stops if either the 1922543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * complete Configuration Information is copied or if the number of bytes indicated by len is copied. Len 1923543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * acts as a safe guard against Configuration Information blocks which have different sizes for different 1924543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hermes versions, e.g. when later versions support more tallies than earlier versions. It is a conscious 1925543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * decision that unused parts of the PC RAM buffer are not cleared. 1926543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1927543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Remarks: The only error against which is protected is the "Read error" as result of Card removal. Only the 1928543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * last hcf_io_string need to be protected because if the first fails the second will fail as well. Checking 1929543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * for cmd_exe errors is supposed superfluous because problems in cmd_exe are already caught or will be 1930543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * caught by hcf_enable. 1931543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1932543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * CFG_MB_INFO: copy the oldest MailBox Info Block or the "null" block if none available. 1933543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1934543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The mechanism to HCF_ASSERT on invalid typ-codes in the LTV record is based on the following strategy: 1935543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - during the pseudo-asynchronous Hermes commands (diagnose, download) only CFG_MB_INFO is acceptable 1936543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - some codes (e.g. CFG_TALLIES) are explicitly handled by the HCF which implies that these codes 1937543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * are valid 1938543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - all other codes in the range 0xFC00 through 0xFFFF are passed to the Hermes. The Hermes returns an 1939543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * LTV record with a zero value in the L-field for all Typ-codes it does not recognize. This is 1940543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * defined and intended behavior, so HCF_ASSERT does not catch on this phenomena. 1941543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - all remaining codes are invalid and cause an ASSERT. 1942543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1943543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.CONDITIONS 1944543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of USB, HCF_MAX_MSG ;?USED;? to limit the amount of data that can be retrieved via hcf_get_info. 1945543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1946543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1947543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 1948543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1949543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 195068c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 195168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_get_info( IFBP ifbp, LTVP ltvp ) 195268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 195368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1954543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 1955543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 len = ltvp->len; 1956543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 type = ltvp->typ; 1957543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_recordp p = <vp->len; //destination word pointer (in LTV record) 1958543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 *q = NULL; /* source word pointer Note!! DOS COM can't cope with FAR 1959543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * as a consequence MailBox must be near which is usually true anyway 1960543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy */ 1961543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i; 196268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1963788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_GET_INFO, ltvp->typ ); 1964788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 1965788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 1966788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ltvp, 0 ); 1967788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( 1 < ltvp->len && ltvp->len <= HCF_MAX_LTV + 1, MERGE_2( ltvp->typ, ltvp->len ) ); 196868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 1969543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->len = 0; //default to: No Info Available 19707c22429923c393853687266cd9d99c13c688f0a1David Kilroy //filter out all specials 197168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot for ( i = 0; ( q = xxxx[i] ) != NULL && q[1] != type; i++ ) /*NOP*/; 19727c22429923c393853687266cd9d99c13c688f0a1David Kilroy 197368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_TALLIES 1974543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( type == CFG_TALLIES ) { /*3*/ 197568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)hcf_action( ifbp, HCF_ACT_TALLIES ); 197668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot q = (hcf_16*)&ifbp->IFB_TallyLen; 197768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 197868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TALLIES 19797c22429923c393853687266cd9d99c13c688f0a1David Kilroy 198068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( type == CFG_MB_INFO ) { 198168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBInfoLen ) { 198268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBp[ifbp->IFB_MBRp] == 0xFFFF ) { 198368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MBRp = 0; //;?Probably superfluous 198468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 198568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot q = &ifbp->IFB_MBp[ifbp->IFB_MBRp]; 1986543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBRp += *q + 1; //update read pointer 198768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBp[ifbp->IFB_MBRp] == 0xFFFF ) { 198868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MBRp = 0; 198968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 199068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MBInfoLen = ifbp->IFB_MBp[ifbp->IFB_MBRp]; 199168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 199268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 19937c22429923c393853687266cd9d99c13c688f0a1David Kilroy 1994543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( q != NULL ) { //a special or CFG_TALLIES or CFG_MB_INFO 1995543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = min( len, *q ) + 1; //total size of destination (including T-field) 199668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( i-- ) { 199768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *p++ = *q; 199868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TALLIES) & HCF_TALLIES_RESET 199968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( q > &ifbp->IFB_TallyTyp && type == CFG_TALLIES ) { 200068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *q = 0; 200168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 200268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TALLIES_RESET 200368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot q++; 200468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2005543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else { // not a special nor CFG_TALLIES nor CFG_MB_INFO 2006543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( type == CFG_CNTL_OPT ) { //read back effective options 200768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltvp->len = 2; 200868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltvp->val[0] = ifbp->IFB_CntlOpt; 200968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_NIC_ACCESS 201068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else if ( type == CFG_PROD_DATA ) { //only needed for some test tool on top of H-II NDIS driver 2011543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_io io_port; 2012543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp pt; //pointer with the "right" type, just to help ease writing macros with embedded assembly 201368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_PAGE, (hcf_16)(PLUG_DATA_OFFSET >> 7) ); 201468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_OFFSET, (hcf_16)(PLUG_DATA_OFFSET & 0x7E) ); 2015543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy io_port = ifbp->IFB_IOBase + HREG_AUX_DATA; //to prevent side effects of the MSF-defined macro 2016543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy p = ltvp->val; //destination char pointer (in LTV record) 2017491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches i = len - 1; 2018491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches if (i > 0 ) { 2019543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy pt = (wci_bufp)p; //just to help ease writing macros with embedded assembly 202068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot IN_PORT_STRING_8_16( io_port, pt, i ); //space used by T: -1 202168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 202268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else if ( type == CFG_CMD_HCF ) { 202368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_CMD_HCF_STRCT FAR *)ltvp) 2024543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( P->cmd == CFG_CMD_HCF_REG_ACCESS, P->cmd ); //only Hermes register access supported 202568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( P->cmd == CFG_CMD_HCF_REG_ACCESS ) { 2026543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( P->mode < ifbp->IFB_IOBase, P->mode ); //Check Register space 2027543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->len = min( len, 4 ); //RESTORE ltv length 202868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot P->add_info = IPW( P->mode ); 202968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 203068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 203168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_NIC_ACCESS 203268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_PRINTF 2033543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else if (type == CFG_FW_PRINTF) { 2034543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = fw_printf(ifbp, (CFG_FW_PRINTF_STRCT*)ltvp); 203568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_PRINTF 203668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else if ( type >= CFG_RID_FW_MIN ) { 203768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//;? by using HCMD_BUSY option when calling cmd_exe, using a get_frag with length 0 just to set up the 203868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//;? BAP and calling cmd_cmpl, you could merge the 2 Busy waits. Whether this really helps (and what 203968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//;? would be the optimal sequence in cmd_exe and get_frag) would have to be MEASURED 2040543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*17*/ if ( ( rc = cmd_exe( ifbp, HCMD_ACCESS, type ) ) == HCF_SUCCESS && 204168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ( rc = setup_bap( ifbp, type, 0, IO_IN ) ) == HCF_SUCCESS ) { 204268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, (wci_bufp)<vp->len, 2*len+2 BE_PAR(2) ); 2043543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( IPW( HREG_STAT ) == 0xFFFF ) { //NIC removal test 204468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltvp->len = 0; 2045788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, type ); 204668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 204768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2048543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*12*/ } else HCFASSERT( DO_ASSERT, type ) /*NOP*/; //NOP in case HCFASSERT is dummy 204968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 205068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len < ltvp->len ) { 205168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltvp->len = len; 205268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( rc == HCF_SUCCESS ) { 205368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_LEN; 205468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 205568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 205668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFASSERT( rc == HCF_SUCCESS || ( rc == HCF_ERR_LEN && ifbp->IFB_AssertTrace & 1<<HCF_TRACE_PUT_INFO ), 2057543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy MERGE_2( type, rc ) ); /*20*/ 2058788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_GET_INFO ); 205968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 206068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_get_info 206168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 206268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 206368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 2064543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2065543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_put_info( IFBP ifbp, LTVP ltvp ) 2066543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Transfers operation and configuration information to the Card and to the HCF. 2067543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2068543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 2069543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 2070543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ltvp specifies the RID (as defined by Hermes I/F) or pseudo-RID (as defined by WCI) 2071543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2072543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 2073543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 2074543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via cmd_exe 2075543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC NIC removed during data retrieval 2076543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT Expected F/W event did not occur in time 2077543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_... 2078543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via download CFG_DLNV_START <= type <= CFG_DL_STOP 2079543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via put_info CFG_RID_CFG_MIN <= type <= CFG_RID_CFG_MAX 2080543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *!! via put_frag 2081543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2082543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 2083543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The L-field of the LTV-record (provided by the MSF in parameter ltvp) specifies the size of the buffer. 2084543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The L-value includes the size of the T-field, but not the size of the L-field. 2085543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The T- field specifies the RID placed in the V-field by the MSF. 2086543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2087543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Not all CFG-codes can be used for hcf_put_info. The following CFG-codes are valid for hcf_put_info: 2088543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o One of the CFG-codes in the group "Network Parameters, Static Configuration Entities" 2089543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Changes made by hcf_put_info to CFG_codes in this group will not affect the F/W 2090543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and HCF behavior until hcf_cntl_port( HCF_PORT_ENABLE) is called. 2091543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o One of the CFG-codes in the group "Network Parameters, Dynamic Configuration Entities" 2092543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Changes made by hcf_put_info to CFG_codes will affect the F/W and HCF behavior immediately. 2093543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o CFG_PROG. 2094543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This code is used to initiate and terminate the process to download data either to 2095543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * volatile or to non-volatile RAM on the NIC as well as for the actual download. 2096543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o CFG-codes related to the HCF behavior. 2097543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The related CFG-codes are: 2098543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_REG_MB 2099543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_REG_ASSERT_RTNP 2100543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_REG_INFO_LOG 2101543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_CMD_NIC 2102543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_CMD_DONGLE 2103543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_CMD_HCF 2104543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - CFG_NOTIFY 2105543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2106543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * All LTV-records "unknown" to the HCF are forwarded to the F/W. 2107543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2108543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 2109543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value. 2110543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ltvp is a NULL pointer. 2111543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - hcf_put_info was called without prior call to hcf_connect 2112543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - type field of the LTV-record is invalid, i.e. neither HCF nor F/W can handle the value. 2113543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - length field of the LTV-record at entry is less than 1 or exceeds MAX_LTV_SIZE. 2114543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - registering a MailBox with size less than 60 or a non-aligned buffer address is used. 2115543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling hcf_functions without adequate protection against 2116543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * NIC interrupts or multi-threading. 2117543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2118543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 2119543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2120543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 2121543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Remarks: In case of Hermes Configuration LTVs, the codes for the type are "cleverly" chosen to be 2122543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * identical to the RID. Hermes Configuration information is copied from the provided data structure into the 2123543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Card. 2124543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of HCF Configuration LTVs, the type values are chosen in a range which does not overlap the 2125543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * RID-range. 2126543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2127543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *20: 2128543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2129543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 2130543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2131543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 213268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 213368c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 213468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_put_info( IFBP ifbp, LTVP ltvp ) 213568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 2136543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 213768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2138788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_PUT_INFO, ltvp->typ ); 2139788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 2140788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 2141788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ltvp, 0 ); 2142788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( 1 < ltvp->len && ltvp->len <= HCF_MAX_LTV + 1, ltvp->len ); 214368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2144543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //all codes between 0xFA00 and 0xFCFF are passed to Hermes 214568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 2146543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 2147543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 2148543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 FAR * key_p; 2149543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 2150543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ltvp->typ == CFG_ADD_TKIP_DEFAULT_KEY || ltvp->typ == CFG_ADD_TKIP_MAPPED_KEY ) { 2151543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy key_p = (hcf_32*)((CFG_ADD_TKIP_MAPPED_KEY_STRCT FAR *)ltvp)->tx_mic_key; 2152543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = TX_KEY; //i.e. TxKeyIndicator == 1, KeyID == 0 2153543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ltvp->typ == CFG_ADD_TKIP_DEFAULT_KEY ) { 2154543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy key_p = (hcf_32*)((CFG_ADD_TKIP_DEFAULT_KEY_STRCT FAR *)ltvp)->tx_mic_key; 2155543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = CNV_LITTLE_TO_SHORT(((CFG_ADD_TKIP_DEFAULT_KEY_STRCT FAR *)ltvp)->tkip_key_id_info); 2156543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 2157543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( i & TX_KEY ) { /* TxKeyIndicator == 1 2158543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (either really set by MSF in case of DEFAULT or faked by HCF in case of MAPPED ) */ 2159543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICTxCntl = (hcf_16)( HFS_TX_CNTL_MIC | (i & KEY_ID )<<8 ); 2160543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICTxKey[0] = CNV_LONGP_TO_LITTLE( key_p ); 2161543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICTxKey[1] = CNV_LONGP_TO_LITTLE( (key_p+1) ); 2162543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 2163543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = ( i & KEY_ID ) * 2; 2164543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICRxKey[i] = CNV_LONGP_TO_LITTLE( (key_p+2) ); 2165543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICRxKey[i+1] = CNV_LONGP_TO_LITTLE( (key_p+3) ); 216668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 216768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_REMOVE_TKIP_DEFAULT_KEY_STRCT FAR *)ltvp) 2168543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( ltvp->typ == CFG_REMOVE_TKIP_MAPPED_KEY ) || 2169543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( ltvp->typ == CFG_REMOVE_TKIP_DEFAULT_KEY && 2170543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( (ifbp->IFB_MICTxCntl >> 8) & KEY_ID ) == CNV_SHORT_TO_LITTLE(P->tkip_key_id ) 2171543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) 2172543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) { ifbp->IFB_MICTxCntl = 0; } //disable MIC-engine 217368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 2174543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 217568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 217668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 217768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltvp->typ == CFG_PROG ) { 217868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = download( ifbp, (CFG_PROG_STRCT FAR *)ltvp ); 217968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else switch (ltvp->typ) { 218068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_RT_MSF_RTN 2181543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_REG_ASSERT_RTNP: //Register MSF Routines 218268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_REG_ASSERT_RTNP_STRCT FAR *)ltvp) 2183543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_AssertRtn = P->rtnp; 2184543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_AssertLvl = P->lvl; //TODO not yet supported so default is set in hcf_connect 2185543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( DO_ASSERT, MERGE_2( HCF_ASSERT, 0xCAF1 ) ); //just to proof that the complete assert machinery is working 218668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 2187543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 218868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_RT_MSF_RTN 218968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_INFO_LOG 2190543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_REG_INFO_LOG: //Register Log filter 2191543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_RIDLogp = ((CFG_RID_LOG_STRCT FAR*)ltvp)->recordp; 2192543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 219368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_INFO_LOG 2194543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_CNTL_OPT: //overrule option 2195543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( ( ltvp->val[0] & ~(USE_DMA | USE_16BIT) ) == 0, ltvp->val[0] ); 2196543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( ltvp->val[0] & USE_DMA ) == 0 ) ifbp->IFB_CntlOpt &= ~USE_DMA; 2197543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CntlOpt |= ltvp->val[0] & USE_16BIT; 2198543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 21997c22429923c393853687266cd9d99c13c688f0a1David Kilroy 2200543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_REG_MB: //Register MailBox 220168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_REG_MB_STRCT FAR *)ltvp) 2202543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( ( (hcf_32)P->mb_addr & 0x0001 ) == 0, (hcf_32)P->mb_addr ); 2203543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( (P)->mb_size >= 60, (P)->mb_size ); 2204543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBp = P->mb_addr; 2205543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* if no MB present, size must be 0 for ;?the old;? put_info_mb to work correctly */ 2206543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBSize = ifbp->IFB_MBp == NULL ? 0 : P->mb_size; 2207543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBWp = ifbp->IFB_MBRp = 0; 2208543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBp[0] = 0; //flag the MailBox as empty 2209543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBInfoLen = 0; 2210543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( ifbp->IFB_MBSize >= 60 || ifbp->IFB_MBp == NULL, ifbp->IFB_MBSize ); 221168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 2212543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 2213543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_MB_INFO: //store MailBoxInfoBlock 2214543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = put_info_mb( ifbp, (CFG_MB_INFO_STRCT FAR *)ltvp ); 2215543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 221668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 221768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_NIC_ACCESS 2218543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_CMD_NIC: 221968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_CMD_NIC_STRCT FAR *)ltvp) 2220543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_PARAM_2, P->parm2 ); 2221543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_PARAM_1, P->parm1 ); 2222543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = cmd_exe( ifbp, P->cmd, P->parm0 ); 2223543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->hcf_stat = (hcf_16)rc; 2224543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->stat = IPW( HREG_STAT ); 2225543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->resp0 = IPW( HREG_RESP_0 ); 2226543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->resp1 = IPW( HREG_RESP_1 ); 2227543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->resp2 = IPW( HREG_RESP_2 ); 2228543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->ifb_err_cmd = ifbp->IFB_ErrCmd; 2229543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy P->ifb_err_qualifier = ifbp->IFB_ErrQualifier; 223068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 2231543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 2232543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_CMD_HCF: 223368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define P ((CFG_CMD_HCF_STRCT FAR *)ltvp) 2234543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( P->cmd == CFG_CMD_HCF_REG_ACCESS, P->cmd ); //only Hermes register access supported 2235543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( P->cmd == CFG_CMD_HCF_REG_ACCESS ) { 2236543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( P->mode < ifbp->IFB_IOBase, P->mode ); //Check Register space 2237543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( P->mode, P->add_info); 2238543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 223968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef P 2240543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 224168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_NIC_ACCESS 224268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 224368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_PRINTF 2244543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy case CFG_FW_PRINTF_BUFFER_LOCATION: 2245543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_FwPfBuff = *(CFG_FW_PRINTF_BUFFER_LOCATION_STRCT*)ltvp; 2246543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy break; 224768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_PRINTF 224868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2249543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy default: //pass everything unknown above the "FID" range to the Hermes or Dongle 2250543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = put_info( ifbp, ltvp ); 2251543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 2252543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //DO NOT !!! HCFASSERT( rc == HCF_SUCCESS, rc ) /* 20 */ 2253788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_PUT_INFO ); 225468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 225568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_put_info 225668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 225768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 225868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 2259543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2260543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_rcv_msg( IFBP ifbp, DESC_STRCT *descp, unsigned int offset ) 2261543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE All: decapsulate a message. 2262543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pre-HermesII.5: verify MIC. 2263543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * non-USB, non-DMA mode: Transfer a message from the NIC to the Host and acknowledge reception. 2264543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * USB: Transform a message from proprietary USB format to 802.3 format 2265543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2266543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 2267543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 2268543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descp Pointer to the Descriptor List location. 2269543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * offset USB: not used 2270543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * non-USB: specifies the beginning of the data to be obtained (0 corresponds with DestAddr field 2271543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of frame). 2272543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2273543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 22744b7ad42963dbc921c8e10f5b9527ecdaadda0602David Kilroy * HCF_SUCCESS No WPA error ( or HCF_ERR_MIC already reported by hcf_service_nic) 2275543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_MIC message contains an erroneous MIC ( HCF_SUCCESS is reported if HCF_ERR_MIC is already 2276543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * reported by hcf_service_nic) 2277543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC NIC removed during data retrieval 2278543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT... 2279543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2280543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 2281543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Receive Message Function can be executed by the MSF to obtain the Data Info fields of the message that 2282543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is reported to be available by the Service NIC Function. 2283543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2284543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Receive Message Function copies the message data available in the Card memory into a buffer structure 2285543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * provided by the MSF. 2286543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Only data of the message indicated by the Service NIC Function can be obtained. 2287543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Execution of the Service NIC function may result in the availability of a new message, but it definitely 2288543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * makes the message reported by the preceding Service NIC function, unavailable. 2289543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2290543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in non-USB/non-DMA mode, hcf_rcv_msg starts the copy process at the (non-negative) offset requested by the 2291543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * parameter offset, relative to HFS_ADDR_DEST, e.g offset 0 starts copying from the Destination Address, the 2292543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * very begin of the 802.3 frame message. Offset must either lay within the part of the 802.3 frame as stored 2293543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * by hcf_service_nic in the lookahead buffer or be just behind it, i.e. the first byte not yet read. 2294543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When offset is within lookahead, data is copied from lookahead. 2295543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When offset is beyond lookahead, data is read directly from RxFS in NIC with disregard of the actual value 2296543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of offset 2297543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2298543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE: 2299543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o at entry: look ahead buffer as passed with hcf_service_nic is still accessible and unchanged 2300543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o at exit: Receive Frame in NIC memory is released 2301543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2302543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Description: 2303543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Starting at the byte indicated by the Offset value, the bytes are copied from the Data Info 2304543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Part of the current Receive Frame Structure to the Host memory data buffer structure 2305543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * identified by descp. 2306543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The maximum value for Offset is the number of characters of the 802.3 frame read into the 2307543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * look ahead buffer by hcf_service_nic (i.e. the look ahead buffer size minus 2308543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Control and 802.11 fields) 2309543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If Offset is less than the maximum value, copying starts from the look ahead buffer till the 2310543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * end of that buffer is reached 2311543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Then (or if the maximum value is specified for Offset), the 2312543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * message is directly copied from NIC memory to Host memory. 2313543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If an invalid (i.e. too large) offset is specified, an assert catches but the buffer contents are 2314543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * undefined. 2315543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Copying stops if either: 2316543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o the end of the 802.3 frame is reached 2317543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o the Descriptor with a NULL pointer in the next_desc_addr field is reached 2318543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2319543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When the copying stops, the receiver is ack'ed, thus freeing the NIC memory where the frame is stored 2320543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * As a consequence, hcf_rcv_msg can only be called once for any particular Rx frame. 2321543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2322543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * For the time being (PCI Bus mastering not yet supported), only the following fields of each 2323543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of the descriptors in the descriptor list must be set by the MSF: 2324543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o buf_cntl.buf_dim[1] 2325543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o *next_desc_addr 2326543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o *buf_addr 2327543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * At return from hcf_rcv_msg, the field buf_cntl.buf_dim[0] of the used Descriptors reflects 2328543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the number of bytes in the buffer corresponding with the Descriptor. 2329543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On the last used Descriptor, buf_cntl.buf_dim[0] is less or equal to buf_cntl.buf_dim[1]. 2330543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On all preceding Descriptors buf_cntl.buf_dim[0] is equal to buf_cntl.buf_dim[1]. 2331543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On all succeeding (unused) Descriptors, buf_cntl.buf_dim[0] is zero. 2332543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: this I/F is based on the assumptions how the I/F needed for PCI Bus mastering will 2333543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * be, so it may change. 2334543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2335543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The most likely handling of HCF_ERR_NO_NIC by the MSF is to drop the already copied 2336543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * data as elegantly as possible under the constraints and requirements posed by the (N)OS. 2337543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If no received Frame Structure is pending, "Success" rather than "Read error" is returned. 2338543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This error constitutes a logic flaw in the MSF 2339543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF can only catch a minority of this 2340543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * type of errors 2341543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Based on consistency ideas, the HCF catches none of these errors. 2342543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2343543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 2344543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value 2345543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - there is no unacknowledged Rx-message available 2346543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - offset is out of range (outside look ahead buffer) 2347543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - descp is a NULL pointer 2348543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - any of the descriptors is not double word aligned 2349543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling hcf_functions without adequate protection 2350543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * against NIC interrupts or multi-threading. 2351543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Interrupts are enabled. 2352543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2353543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 2354543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2355543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 2356543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - by using unsigned int as type for offset, no need to worry about negative offsets 2357543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Asserting on being enabled/present is superfluous, since a non-zero IFB_lal implies that hcf_service_nic 2358543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * was called and detected a Rx-message. A zero IFB_lal will set the BUF_CNT field of at least the first 2359543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descriptor to zero. 2360543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2361543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 2362543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2363543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 236468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 236568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_rcv_msg( IFBP ifbp, DESC_STRCT *descp, unsigned int offset ) 236668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 2367543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 2368543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp cp; //char oriented working pointer 2369543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 2370543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int tot_len = ifbp->IFB_RxLen - offset; //total length 2371543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp lap = ifbp->IFB_lap + offset; //start address in LookAhead Buffer 2372543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 lal = ifbp->IFB_lal - offset; //available data within LookAhead Buffer 2373543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 j; 237468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2375788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_RCV_MSG, offset ); 2376788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 2377788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 2378788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( descp, HCF_TRACE_RCV_MSG ); 2379788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_RxLen, HCF_TRACE_RCV_MSG ); 2380788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_RxLen >= offset, MERGE_2( offset, ifbp->IFB_RxLen ) ); 2381788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_lal >= offset, offset ); 2382788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (ifbp->IFB_CntlOpt & USE_DMA) == 0, 0xDADA ); 238368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 238468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( tot_len < 0 ) { 2385543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy lal = 0; tot_len = 0; //suppress all copying activity in the do--while loop 238668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2387543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy do { //loop over all available fragments 238868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // obnoxious hcf.c(1480) : warning C4769: conversion of near pointer to long integer 2389788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)descp & 3 ) == 0, (hcf_32)descp ); 239068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot cp = descp->buf_addr; 2391543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy j = min( (hcf_16)tot_len, descp->BUF_SIZE ); //minimum of "what's` available" and fragment size 239268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot descp->BUF_CNT = j; 2393543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy tot_len -= j; //adjust length still to go 2394543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( lal ) { //if lookahead Buffer not yet completely copied 2395543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = min( lal, j ); //minimum of "what's available" in LookAhead and fragment size 2396543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy lal -= i; //adjust length still available in LookAhead 2397543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy j -= i; //adjust length still available in current fragment 239868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /*;? while loop could be improved by moving words but that is complicated on platforms with 239968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * alignment requirements*/ 240068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( i-- ) *cp++ = *lap++; 240168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2402543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( j ) { //if LookAhead Buffer exhausted but still space in fragment, copy directly from NIC RAM 240368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, cp, j BE_PAR(0) ); 240468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot CALC_RX_MIC( cp, j ); 240568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 240668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } while ( ( descp = descp->next_desc_addr ) != NULL ); 240768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 240868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_RxFID ) { 2409543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = check_mic( ifbp ); //prevents MIC error report if hcf_service_nic already consumed all 241068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 241168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 2412543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (void)hcf_action( ifbp, HCF_ACT_RX_ACK ); //only 1 shot to get the data, so free the resources in the NIC 2413788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( rc == HCF_SUCCESS, rc ); 2414788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_RCV_MSG ); 241568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 241668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_rcv_msg 241768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 241868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 241968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 2420543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2421543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_send_msg( IFBP ifbp, DESC_STRCT *descp, hcf_16 tx_cntl ) 2422543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Encapsulate a message and append padding and MIC. 2423543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * non-USB: Transfers the resulting message from Host to NIC and initiates transmission. 2424543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * USB: Transfer resulting message into a flat buffer. 2425543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2426543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 2427543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 2428543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descp pointer to the DescriptorList or NULL 2429543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * tx_cntl indicates MAC-port and (Hermes) options 2430543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_SPECTRALINK 2431543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_PRIO 2432543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_TX_OK 2433543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_TX_EX 2434543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_TX_DELAY 2435543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_TX_CONT 2436543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_0 MAC Port 0 (default) 2437543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_1 (AP only) MAC Port 1 2438543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_2 (AP only) MAC Port 2 2439543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_3 (AP only) MAC Port 3 2440543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_4 (AP only) MAC Port 4 2441543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_5 (AP only) MAC Port 5 2442543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_PORT_6 (AP only) MAC Port 6 2443543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2444543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 2445543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 2446543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_.. 2447543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT 2448543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2449543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION: 2450543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Send Message Function embodies 2 functions: 2451543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o transfers a message (including MAC header) from the provided buffer structure in Host memory to the Transmit 2452543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Frame Structure (TxFS) in NIC memory. 2453543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o Issue a send command to the F/W to actually transmit the contents of the TxFS. 2454543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2455543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Control is based on the Resource Indicator IFB_RscInd. 2456543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Resource Indicator is maintained by the HCF and should only be interpreted but not changed by the MSF. 2457543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The MSF must check IFB_RscInd to be non-zero before executing the call to the Send Message Function. 2458543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When no resources are available, the MSF must handle the queuing of the Transmit frame and check the 2459543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Resource Indicator periodically after calling hcf_service_nic. 2460543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2461543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Send Message Functions transfers a message to NIC memory when it is called with a non-NULL descp. 2462543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Before the Send Message Function is invoked this way, the Resource Indicator (IFB_RscInd) must be checked. 2463543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the Resource is not available, Send Message Function execution must be postponed until after processing of 2464543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a next hcf_service_nic it appears that the Resource has become available. 2465543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The message is copied from the buffer structure identified by descp to the NIC. 2466543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Copying stops if a NULL pointer in the next_desc_addr field is reached. 2467543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hcf_send_msg does not check for transmit buffer overflow, because the F/W does this protection. 2468543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of a transmit buffer overflow, the surplus which does not fit in the buffer is simply dropped. 2469543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2470543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Send Message Function activates the F/W to actually send the message to the medium when the 2471543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HFS_TX_CNTL_TX_DELAY bit of the tx_cntl parameter is not set. 2472543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the descp parameter of the current call is non-NULL, the message as represented by descp is send. 2473543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the descp parameter of the current call is NULL, and if the preceding call of the Send Message Function had 2474543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a non-NULL descp and the preceding call had the HFS_TX_CNTL_TX_DELAY bit of tx_cntl set, then the message as 2475543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * represented by the descp of the preceding call is send. 2476543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2477543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hcf_send_msg supports encapsulation (see HCF_ENCAP) of Ethernet-II frames. 2478543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * An Ethernet-II frame is transferred to the Transmit Frame structure as an 802.3 frame. 2479543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hcf_send_msg distinguishes between an 802.3 and an Ethernet-II frame by looking at the data length/type field 2480543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of the frame. If this field contains a value larger than 1514, the frame is considered to be an Ethernet-II 2481543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * frame, otherwise it is treated as an 802.3 frame. 2482543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * To ease implementation of the HCF, this type/type field must be located in the first descriptor structure, 2483543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * i.e. the 1st fragment must have a size of at least 14 (to contain DestAddr, SrcAddr and Len/Type field). 2484543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * An Ethernet-II frame is encapsulated by inserting a SNAP header between the addressing information and the 2485543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * type field. This insertion is transparent for the MSF. 2486543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The HCF contains a fixed table that stores a number of types. If the value specified by the type/type field 2487543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * occurs in this table, Bridge Tunnel Encapsulation is used, otherwise RFC1042 encapsulation is used. 2488543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Bridge Tunnel uses AA AA 03 00 00 F8 as SNAP header, 2489543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * RFC1042 uses AA AA 03 00 00 00 as SNAP header. 2490543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The table currently contains: 2491543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0 0x80F3 AppleTalk Address Resolution Protocol (AARP) 2492543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0 0x8137 IPX 2493543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2494543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The algorithm to distinguish between 802.3 and Ethernet-II frames limits the maximum length for frames of 2495543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 802.3 frames to 1514 bytes. 2496543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Encapsulation can be suppressed by means of the system constant HCF_ENCAP, e.g. to support proprietary 2497543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * protocols with 802.3 like frames with a size larger than 1514 bytes. 2498543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2499543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case the HCF encapsulates the frame, the number of bytes that is actually transmitted is determined by the 2500543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * cumulative value of the buf_cntl.buf_dim[0] fields. 2501543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case the HCF does not encapsulate the frame, the number of bytes that is actually transmitted is not 2502543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * determined by the cumulative value of the buf_cntl.buf_dim[DESC_CNTL_CNT] fields of the desc_strct's but by 2503543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the Length field of the 802.3 frame. 2504543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If there is a conflict between the cumulative value of the buf_cntl.buf_dim[0] fields and the 2505543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 802.3 Length field the 802.3 Length field determines the number of bytes actually transmitted by the NIC while 2506543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the cumulative value of the buf_cntl.buf_dim[0] fields determines the position of the MIC, hence a mismatch 2507543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * will result in MIC errors on the Receiving side. 2508543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Currently this problem is flagged on the Transmit side by an Assert. 2509543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The following fields of each of the descriptors in the descriptor list must be set by the MSF: 2510543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o buf_cntl.buf_dim[0] 2511543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o *next_desc_addr 2512543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o *buf_addr 2513543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2514543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * All bits of the tx_cntl parameter except HFS_TX_CNTL_TX_DELAY and the HCF_PORT# bits are passed to the F/W via 2515543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the HFS_TX_CNTL field of the TxFS. 2516543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2517543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that hcf_send_msg does not detect NIC absence. The MSF is supposed to have its own -platform dependent- 2518543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * way to recognize card removal/insertion. 2519543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The total system must be robust against card removal and there is no principal difference between card removal 2520543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * just after hcf_send_msg returns but before the actual transmission took place or sometime earlier. 2521543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2522543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert fails if 2523543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - ifbp has a recognizable out-of-range value 2524543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - descp is a NULL pointer 2525543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - no resources for PIF available. 2526543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - Interrupts are enabled. 2527543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - reentrancy, may be caused by calling hcf_functions without adequate protection 2528543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * against NIC interrupts or multi-threading. 2529543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2530543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 2531543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: for the normal case (i.e. no HFS_TX_CNTL_TX_DELAY option active), a fid is acquired via the 2532543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * routine get_fid. If no FID is acquired, the remainder is skipped without an error notification. After 2533543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * all, the MSF is not supposed to call hcf_send_msg when no Resource is available. 2534543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *7: The ControlField of the TxFS is written. Since put_frag can only return the fatal Defunct or "No NIC", the 2535543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * return status can be ignored because when it fails, cmd_wait will fail as well. (see also the note on the 2536543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * need for a return code below). 25374b7ad42963dbc921c8e10f5b9527ecdaadda0602David Kilroy * Note that HFS_TX_CNTL has different values for H-I, H-I/WPA and H-II and HFS_ADDR_DEST has different 25384b7ad42963dbc921c8e10f5b9527ecdaadda0602David Kilroy * values for H-I (regardless of WPA) and H-II. 2539543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * By writing 17, 1 or 2 ( implying 16, 0 or 1 garbage word after HFS_TX_CNTL) the BAP just gets to 25404b7ad42963dbc921c8e10f5b9527ecdaadda0602David Kilroy * HFS_ADDR_DEST for H-I, H-I/WPA and H-II respectively. 2541543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *10: if neither encapsulation nor MIC calculation is needed, splitting the first fragment in two does not 2542543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * really help but it makes the flow easier to follow to do not optimize on this difference 2543543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2544543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_send_msg checks whether the frame is an Ethernet-II rather than an "official" 802.3 frame. 2545543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The E-II check is based on the length/type field in the MAC header. If this field has a value larger than 2546543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1500, E-II is assumed. The implementation of this test fails if the length/type field is not in the first 2547543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * descriptor. If E-II is recognized, a SNAP header is inserted. This SNAP header represents either RFC1042 2548543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * or Bridge-Tunnel encapsulation, depending on the return status of the support routine hcf_encap. 2549543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2550543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 2551543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_send_msg leaves the responsibility to only send messages on enabled ports at the MSF level. 2552543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This is considered the strategy which is sufficiently adequate for all "robust" MSFs, have the least 2553543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * processor utilization and being still acceptable robust at the WCI !!!!! 2554543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2555543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_send_msg does not NEED a return value to report NIC absence or removal during the execution of 2556543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_send_msg(), because the MSF and higher layers must be able to cope anyway with the NIC being removed 2557543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * after a successful completion of hcf_send_msg() but before the actual transmission took place. 2558543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * To accommodate user expectations the current implementation does report NIC absence. 2559543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Defunct blocks all NIC access and will (also) be reported on a number of other calls. 2560543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2561543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_send_msg does not check for transmit buffer overflow because the Hermes does this protection. 2562543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of a transmit buffer overflow, the surplus which does not fit in the buffer is simply dropped. 2563543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that this possibly results in the transmission of incomplete frames. 2564543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2565543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * After some deliberation with F/W team, it is decided that - being in the twilight zone of not knowing 2566543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * whether the problem at hand is an MSF bug, HCF buf, F/W bug, H/W malfunction or even something else - there 2567543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is no "best thing to do" in case of a failing send, hence the HCF considers the TxFID ownership to be taken 2568543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * over by the F/W and hopes for an Allocate event in due time 2569543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2570543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 2571543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2572543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 257368c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 257468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_send_msg( IFBP ifbp, DESC_STRCT *descp, hcf_16 tx_cntl ) 257568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 2576543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 2577543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DESC_STRCT *p /* = descp*/; //working pointer 2578543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 len; // total byte count 2579543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 258068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2581543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 fid = 0; 258268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2583788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_RscInd || descp == NULL, ifbp->IFB_RscInd ); 2584788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (ifbp->IFB_CntlOpt & USE_DMA) == 0, 0xDADB ); 258568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2586788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_SEND_MSG, tx_cntl ); 2587788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 2588788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 258968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* obnoxious c:/hcf/hcf.c(1480) : warning C4769: conversion of near pointer to long integer, 259068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * so skip */ 2591788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)descp & 3 ) == 0, (hcf_32)descp ); 259268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 2593543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { int x = ifbp->IFB_FWIdentity.comp_id == COMP_ID_FW_AP ? tx_cntl & ~HFS_TX_CNTL_PORT : tx_cntl; 2594543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( (x & ~HCF_TX_CNTL_MASK ) == 0, tx_cntl ); 2595543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 259668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 259768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2598543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( descp ) ifbp->IFB_TxFID = 0; //cancel a pre-put message 259968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2600543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* the following initialization code is redundant for a pre-put message 2601543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * but moving it inside the "if fid" logic makes the merging with the 2602543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * USB flow awkward 2603543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy */ 260468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 260568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot tx_cntl |= ifbp->IFB_MICTxCntl; 260668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 2607491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches fid = ifbp->IFB_TxFID; 2608543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if (fid == 0 && ( fid = get_fid( ifbp ) ) != 0 ) /* 4 */ 2609543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* skip the next compound statement if: 2610543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy - pre-put message or 2611543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy - no fid available (which should never occur if the MSF adheres to the WCI) 2612543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy */ 2613543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { // to match the closing curly bracket of above "if" in case of HCF_TYPE_USB 2614543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //calculate total length ;? superfluous unless CCX or Encapsulation 261568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len = 0; 261668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = descp; 261768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot do len += p->BUF_CNT; while ( ( p = p->next_desc_addr ) != NULL ); 261868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = descp; 2619543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//;? HCFASSERT( len <= HCF_MAX_MSG, len ); 2620543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*7*/ (void)setup_bap( ifbp, fid, HFS_TX_CNTL, IO_OUT ); 262168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_TX_DELAY 2622788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ( descp != NULL ) ^ ( tx_cntl & HFS_TX_CNTL_TX_DELAY ), tx_cntl ); 262368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( tx_cntl & HFS_TX_CNTL_TX_DELAY ) { 2624543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy tx_cntl &= ~HFS_TX_CNTL_TX_DELAY; //!!HFS_TX_CNTL_TX_DELAY no longer available 262568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_TxFID = fid; 2626543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy fid = 0; //!!fid no longer available, be careful when modifying code 262768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 262868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_TX_DELAY 262968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_DATA_1, tx_cntl ) ; 263068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_DATA_1, 0 ); 263189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy 2632788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( p->BUF_CNT >= 14, p->BUF_CNT ); 2633543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* assume DestAddr/SrcAddr/Len/Type ALWAYS contained in 1st fragment 2634543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * otherwise life gets too cumbersome for MIC and Encapsulation !!!!!!!! 2635543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( p->BUF_CNT >= 14 ) { alternatively: add a safety escape !!!!!!!!!!!! } */ 263689c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy 2637543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_TX_MIC( NULL, -1 ); //initialize MIC 2638543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*10*/ put_frag( ifbp, p->buf_addr, HCF_DASA_SIZE BE_PAR(0) ); //write DA, SA with MIC calculation 2639543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_TX_MIC( p->buf_addr, HCF_DASA_SIZE ); //MIC over DA, SA 2640543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_TX_MIC( null_addr, 4 ); //MIC over (virtual) priority field 264168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2642543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if encapsulation needed 264368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ENCAP) == HCF_ENC 2644543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //write length (with SNAP-header,Type, without //DA,SA,Length ) no MIC calc. 264589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( ( snap_header[sizeof(snap_header)-1] = hcf_encap( &p->buf_addr[HCF_DASA_SIZE] ) ) != ENC_NONE ) { 264689c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy OPW( HREG_DATA_1, CNV_END_SHORT( len + (sizeof(snap_header) + 2) - ( 2*6 + 2 ) ) ); 2647543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //write splice with MIC calculation 264889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy put_frag( ifbp, snap_header, sizeof(snap_header) BE_PAR(0) ); 264989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy CALC_TX_MIC( snap_header, sizeof(snap_header) ); //MIC over 6 byte SNAP 265089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy i = HCF_DASA_SIZE; 265189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy } else 265268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ENC 265389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy { 265489c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy OPW( HREG_DATA_1, *(wci_recordp)&p->buf_addr[HCF_DASA_SIZE] ); 265589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy i = 14; 265668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 265789c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy //complete 1st fragment starting with Type with MIC calculation 265889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy put_frag( ifbp, &p->buf_addr[i], p->BUF_CNT - i BE_PAR(0) ); 265989c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy CALC_TX_MIC( &p->buf_addr[i], p->BUF_CNT - i ); 266089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy 2661543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //do the remaining fragments with MIC calculation 266268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( ( p = p->next_desc_addr ) != NULL ) { 266368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* obnoxious c:/hcf/hcf.c(1480) : warning C4769: conversion of near pointer to long integer, 266468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * so skip */ 2665788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)p & 3 ) == 0, (hcf_32)p ); 266668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frag( ifbp, p->buf_addr, p->BUF_CNT BE_PAR(0) ); 266768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot CALC_TX_MIC( p->buf_addr, p->BUF_CNT ); 266868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2669543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //pad message, finalize MIC calculation and write MIC to NIC 267068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frag_finalize( ifbp ); 267168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 267268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( fid ) { 2673543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*16*/ rc = cmd_exe( ifbp, HCMD_BUSY | HCMD_TX | HCMD_RECL, fid ); 267468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_TxFID = 0; 2675543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* probably this (i.e. no RscInd AND "HREG_EV_ALLOC") at this point in time occurs so infrequent, 2676543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * that it might just as well be acceptable to skip this 2677543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "optimization" code and handle that additional interrupt once in a while 2678543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy */ 267968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 180 degree error in logic ;? #if ALLOC_15 2680543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*20*/ if ( ifbp->IFB_RscInd == 0 ) { 268168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RscInd = get_fid( ifbp ); 268268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 268368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #endif // ALLOC_15 268468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2685788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy// HCFASSERT( level::ifbp->IFB_RscInd, ifbp->IFB_RscInd ); 2686788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_SEND_MSG ); 268768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 268868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_send_msg 268968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 269068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 269168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 2692543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2693543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.MODULE int hcf_service_nic( IFBP ifbp, wci_bufp bufp, unsigned int len ) 2694543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Services (most) NIC events. 2695543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Provides received message 2696543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Provides status information. 2697543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2698543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 2699543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 2700543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In non-DMA mode: 2701543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bufp address of char buffer, sufficiently large to hold the first part of the RxFS up through HFS_TYPE 2702543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len length in bytes of buffer specified by bufp 2703543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * value between HFS_TYPE + 2 and HFS_ADDR_DEST + HCF_MAX_MSG 2704543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2705543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 2706543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 2707543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_MIC message contains an erroneous MIC (only if frame fits completely in bufp) 2708543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2709543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 2710543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 2711543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * MSF-accessible fields of Result Block 2712543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_RxLen 0 or Frame size. 2713543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_MBInfoLen 0 or the L-field of the oldest MBIB. 2714543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_RscInd 2715543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_HCF_Tallies updated if a corresponding event occurred. 2716543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_NIC_Tallies updated if a Tally Info frame received from the NIC. 2717543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_DmaPackets 2718543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_TxFsStat 2719543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_TxFsSwSup 2720543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - IFB_LinkStat reflects new link status or 0x0000 if no change relative to previous hcf_service_nic call. 272168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootor 2722543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - IFB_LinkStat link status, 0x8000 reflects change relative to previous hcf_service_nic call. 272368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 272468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* When IFB_MBInfoLen is non-zero, at least one MBIB is available. 272568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 2726543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* IFB_RxLen reflects the number of received bytes in 802.3 view (Including DestAddr, SrcAddr and Length, 272768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* excluding MIC-padding, MIC and sum check) of active Rx Frame Structure. If no Rx Data s available, IFB_RxLen 272868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* equals 0x0000. 272968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Repeated execution causes the Service NIC Function to provide information about subsequently received 273068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* messages, irrespective whether a hcf_rcv_msg or hcf_action(HCF_ACT_RX) is performed in between. 273168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 273268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* When IFB_RxLen is non-zero, a Received Frame Structure is available to be routed to the protocol stack. 273368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* When Monitor Mode is not active, this is guaranteed to be an error-free non-WMP frame. 273468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* In case of Monitor Mode, it may also be a frame with an error or a WMP frame. 273568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Erroneous frames have a non-zero error-sub field in the HFS_STAT field in the look ahead buffer. 273668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 273768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* If a Receive message is available in NIC RAM, the Receive Frame Structure is (partly) copied from the NIC to 273868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* the buffer identified by bufp. 273968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Copying stops either after len bytes or when the complete 802.3 frame is copied. 274068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* During the copying the message is decapsulated (if appropriate). 274168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* If the frame is read completely by hcf_service_nic (i.e. the frame fits completely in the lookahead buffer), 274268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* the frame is automatically ACK'ed to the F/W and still available via the look ahead buffer and hcf_rcv_msg. 274368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Only if the frame is read completely by hcf_service_nic, hcf_service_nic checks the MIC and sets the return 274468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* status accordingly. In this case, hcf_rcv_msg does not check the MIC. 274568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 274668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The MIC calculation algorithm works more efficient if the length of the look ahead buffer is 274768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* such that it fits exactly 4 n bytes of the 802.3 frame, i.e. len == HFS_ADDR_DEST + 4*n. 274868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 274968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The Service NIC Function supports the NIC event service handling process. 275068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* It performs the appropriate actions to service the NIC, such that the event cause is eliminated and related 275168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* information is saved. 275268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The Service NIC Function is executed by the MSF ISR or polling routine as first step to determine the event 275368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* cause(s). It is the responsibility of the MSF to perform all not directly NIC related interrupt service 275468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* actions, e.g. in a PC environment this includes servicing the PIC, and managing the Processor Interrupt 275568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Enabling/Disabling. 275668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* In case of a polled based system, the Service NIC Function must be executed "frequently". 275768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The Service NIC Function may have side effects related to the Mailbox and Resource Indicator (IFB_RscInd). 275868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 275968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* hcf_service_nic returns: 276068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - The length of the data in the available MBIB (IFB_MBInfoLen) 276168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - Changes in the link status (IFB_LinkStat) 276268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - The length of the data in the available Receive Frame Structure (IFB_RxLen) 276368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - updated IFB_RscInd 276468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - Updated Tallies 276568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 276668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* hcf_service_nic is presumed to neither interrupt other HCF-tasks nor to be interrupted by other HCF-tasks. 276768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* A way to achieve this is to precede hcf_service_nic as well as all other HCF-tasks with a call to 276868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* hcf_action to disable the card interrupts and, after all work is completed, with a call to hcf_action to 276968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* restore (which is not necessarily the same as enabling) the card interrupts. 277068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* In case of a polled environment, it is assumed that the MSF programmer is sufficiently familiar with the 277168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* specific requirements of that environment to translate the interrupt strategy to a polled strategy. 277268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 277368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* hcf_service_nic services the following Hermes events: 2774543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_INFO Asynchronous Information Frame 2775543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_INFO_DROP WMAC did not have sufficient RAM to build Unsolicited Information Frame 2776543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_TX_EXC (if applicable, i.e. selected via HCF_EXT_INT_TX_EX bit of HCF_EXT) 2777543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_SLEEP_REQ (if applicable, i.e. selected via HCF_DDS/HCF_CDS bit of HCF_SLEEP) 277868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* ** in non_DMA mode 2779543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_ALLOC Asynchronous part of Allocation/Reclaim completed while out of resources at 2780543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* completion of hcf_send_msg/notify 2781543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_RX the detection of the availability of received messages 2782543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* including WaveLAN Management Protocol (WMP) message processing 278368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* ** in DMA mode 278468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - HREG_EV_RDMAD 278568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - HREG_EV_TDMAD 278668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*!! hcf_service_nic does not service the following Hermes events: 2787543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! HREG_EV_TX (the "OK" Tx Event) is no longer supported by the WCI, if it occurs it is unclear 2788543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! what the cause is, so no meaningful strategy is available. Not acking the bit is 2789543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! probably the best help that can be given to the debugger. 2790543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! HREG_EV_CMD handled in cmd_wait. 2791543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! HREG_EV_FW_DMA (i.e. HREG_EV_RXDMA, HREG_EV_TXDMA and_EV_LPESC) are either not used or used 2792543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! between the F/W and the DMA engine. 2793543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*!! HREG_EV_ACK_REG_READY is only applicable for H-II (i.e. not HII.5 and up, see DAWA) 2794543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 2795543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* If, in non-DMA mode, a Rx message is available, its length is reflected by the IFB_RxLen field of the IFB. 2796543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* This length reflects the data itself and the Destination Address, Source Address and DataLength/Type field 2797543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* but not the SNAP-header in case of decapsulation by the HCF. If no message is available, IFB_RxLen is 2798543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* zero. Former versions of the HCF handled WMP messages and supported a "monitor" mode in hcf_service_nic, 2799543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* which deposited certain or all Rx messages in the MailBox. The responsibility to handle these frames is 2800543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* moved to the MSF. The HCF offers as supports hcf_put_info with CFG_MB_INFO as parameter to emulate the old 2801543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* implementation under control of the MSF. 280268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 280368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* **Rx Buffer free strategy 2804543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* When hcf_service_nic reports the availability of a non-DMA message, the MSF can access that message by 2805543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* means of hcf_rcv_msg. It must be prevented that the LAN Controller writes new data in the NIC buffer 2806543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* before the MSF is finished with the current message. The NIC buffer is returned to the LAN Controller 2807543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* when: 2808543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - the complete frame fits in the lookahead buffer or 2809543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - hcf_rcv_msg is called or 2810543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - hcf_action with HCF_ACT_RX is called or 2811543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - hcf_service_nic is called again 2812543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* It can be reasoned that hcf_action( INT_ON ) should not be given before the MSF has completely processed 2813543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* a reported Rx-frame. The reason is that the INT_ON action is guaranteed to cause a (Rx-)interrupt (the 2814543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* MSF is processing a Rx-frame, hence the Rx-event bit in the Hermes register must be active). This 2815543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* interrupt will cause hcf_service_nic to be called, which will cause the ack-ing of the "last" Rx-event 2816543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* to the Hermes, causing the Hermes to discard the associated NIC RAM buffer. 281768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* Assert fails if 281868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - ifbp is zero or other recognizable out-of-range value. 281968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - hcf_service_nic is called without a prior call to hcf_connect. 282068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - interrupts are enabled. 282168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* - reentrancy, may be caused by calling hcf_functions without adequate protection 2822543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* against NIC interrupts or multi-threading. 282368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 282468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 282568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*.DIAGRAM 2826543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*1: IFB_LinkStat is cleared, if a LinkStatus frame is received, IFB_LinkStat will be updated accordingly 2827543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* by isr_info. 282868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootor 2829543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*1: IFB_LinkStat change indication is cleared. If a LinkStatus frame is received, IFB_LinkStat will be updated 2830543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* accordingly by isr_info. 283168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*2: IFB_RxLen must be cleared before the NIC presence check otherwise: 2832543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - this value may stay non-zero if the NIC is pulled out at an inconvenient moment. 2833543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - the RxAck on a zero-FID needs a zero-value for IFB_RxLen to work 2834543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note that as side-effect of the hcf_action call, the remainder of Rx related info is re-initialized as 2835543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* well. 2836543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*4: In case of Defunct mode, the information supplied by Hermes is unreliable, so the body of 2837543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* hcf_service_nic is skipped. Since hcf_cntl turns into a NOP if Primary or Station F/W is incompatible, 2838543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* hcf_service_nic is also skipped in those cases. 2839543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* To prevent that hcf_service_nic reports bogus information to the MSF with all - possibly difficult to 2840543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* debug - undesirable side effects, it is paramount to check the NIC presence. In former days the presence 2841543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* test was based on the Hermes register HREG_SW_0. Since in HCF_ACT_INT_OFF is chosen for strategy based on 2842543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* HREG_EV_STAT, this is now also used in hcf_service_nic. The motivation to change strategy is partly 2843543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* due to inconsistent F/W implementations with respect to HREG_SW_0 manipulation around reset and download. 2844543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note that in polled environments Card Removal is not detected by INT_OFF which makes the check in 2845543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* hcf_service_nic even more important. 2846543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*8: The event status register of the Hermes is sampled 2847543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The assert checks for unexpected events ;?????????????????????????????????????. 2848543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_INFO_DROP is explicitly excluded from the acceptable HREG_EV_STAT bits because it indicates 2849543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* a too heavily loaded system. 2850543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - HREG_EV_ACK_REG_READY is 0x0000 for H-I (and hopefully H-II.5) 2851543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 2852543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 2853543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* HREG_EV_TX_EXC is accepted (via HREG_EV_TX_EXT) if and only if HCF_EXT_INT_TX_EX set in the HCF_EXT 2854543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* definition at compile time. 2855543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The following activities are handled: 2856543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - Alloc events are handled by hcf_send_msg (and notify). Only if there is no "spare" resource, the 2857543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* alloc event is superficially serviced by hcf_service_nic to create a pseudo-resource with value 2858543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 0x001. This value is recognized by get_fid (called by hcf_send_msg and notify) where the real 2859543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* TxFid is retrieved and the Hermes is acked and - hopefully - the "normal" case with a spare TxFid 2860543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* in IFB_RscInd is restored. 2861543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - Info drop events are handled by incrementing a tally 2862543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - LinkEvent (including solicited and unsolicited tallies) are handled by procedure isr_info. 2863543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - TxEx (if selected at compile time) is handled by copying the significant part of the TxFS 2864543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* into the IFB for further processing by the MSF. 2865543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note the complication of the zero-FID protection sub-scheme in DAWA. 2866543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note, the Ack of all of above events is handled at the end of hcf_service_nic 286768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*16: In case of non-DMA ( either not compiled in or due to a run-time choice): 2868543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* If an Rx-frame is available, first the FID of that frame is read, including the complication of the 2869543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* zero-FID protection sub-scheme in DAWA. Note that such a zero-FID is acknowledged at the end of 2870543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* hcf_service_nic and that this depends on the IFB_RxLen initialization in the begin of hcf_service_nic. 2871543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The Assert validates the HCF assumption about Hermes implementation upon which the range of 2872543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Pseudo-RIDs is based. 2873543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Then the control fields up to the start of the 802.3 frame are read from the NIC into the lookahead buffer. 2874543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The status field is converted to native Endianess. 2875543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The length is, after implicit Endianess conversion if needed, and adjustment for the 14 bytes of the 2876543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 802.3 MAC header, stored in IFB_RxLen. 2877543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* In MAC Monitor mode, 802.11 control frames with a TOTAL length of 14 are received, so without this 2878543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* length adjustment, IFB_RxLen could not be used to distinguish these frames from "no frame". 2879543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* No MIC calculation processes are associated with the reading of these Control fields. 288068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*26: This length test feels like superfluous robustness against malformed frames, but it turned out to be 2881543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* needed in the real (hostile) world. 2882543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The decapsulation check needs sufficient data to represent DA, SA, L, SNAP and Type which amounts to 2883543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 22 bytes. In MAC Monitor mode, 802.11 control frames with a smaller length are received. To prevent 2884543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* that the implementation goes haywire, a check on the length is needed. 2885543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The actual decapsulation takes place on the fly in the copying process by overwriting the SNAP header. 2886543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note that in case of decapsulation the SNAP header is not passed to the MSF, hence IFB_RxLen must be 2887543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* compensated for the SNAP header length. 2888543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* The 22 bytes needed for decapsulation are (more than) sufficient for the exceptional handling of the 2889543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* MIC algorithm of the L-field (replacing the 2 byte L-field with 4 0x00 bytes). 28904b7ad42963dbc921c8e10f5b9527ecdaadda0602David Kilroy*30: The 12 in the no-WPA branch corresponds with the get_frag, the 2 with the IPW of the WPA branch 289168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*32: If Hermes reported MIC-presence, than the MIC engine is initialized with the non-dummy MIC calculation 2892543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* routine address and appropriate key. 289368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*34: The 8 bytes after the DA, SA, L are read and it is checked whether decapsulation is needed i.e.: 2894543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - the Hermes reported Tunnel encapsulation or 2895543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - the Hermes reported 1042 Encapsulation and hcf_encap reports that the HCF would not have used 2896543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* 1042 as the encapsulation mechanism 2897543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note that the first field of the RxFS in bufp has Native Endianess due to the conversion done by the 2898543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* BE_PAR in get_frag. 289968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*36: The Type field is the only word kept (after moving) of the just read 8 bytes, it is moved to the 2900543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* L-field. The original L-field and 6 byte SNAP header are discarded, so IFB_RxLen and buf_addr must 2901543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* be adjusted by 8. 290268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*40: Determine how much of the frame (starting with DA) fits in the Lookahead buffer, then read the not-yet 2903543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* read data into the lookahead buffer. 2904543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* If the lookahead buffer contains the complete message, check the MIC. The majority considered this 2905543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* I/F more appropriate then have the MSF call hcf_get_data only to check the MIC. 290668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*44: Since the complete message is copied from NIC RAM to PC RAM, the Rx can be acknowledged to the Hermes 2907543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* to optimize the flow ( a better chance to get new Rx data in the next pass through hcf_service_nic ). 2908543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* This acknowledgement can not be done via hcf_action( HCF_ACT_RX_ACK ) because this also clears 2909543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* IFB_RxLEN thus corrupting the I/F to the MSF. 291068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*;?: In case of DMA (compiled in and activated): 291168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 291268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 291368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*54: Limiting the number of places where the F/W is acked (e.g. the merging of the Rx-ACK with the other 2914543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* ACKs), is supposed to diminish the potential of race conditions in the F/W. 2915543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note 1: The CMD event is acknowledged in cmd_cmpl 2916543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note 2: HREG_EV_ACK_REG_READY is 0x0000 for H-I (and hopefully H-II.5) 2917543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* Note 3: The ALLOC event is acknowledged in get_fid (except for the initialization flow) 291868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 291968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*.NOTICE 292068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The Non-DMA HREG_EV_RX is handled different compared with the other F/W events. 292168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The HREG_EV_RX event is acknowledged by the first hcf_service_nic call after the 292268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* hcf_service_nic call that reported the occurrence of this event. 292368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* This acknowledgment 292468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* makes the next Receive Frame Structure (if any) available. 292568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* An updated IFB_RxLen 292668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* field reflects this availability. 292768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 292868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*.NOTICE 292968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* The minimum size for Len must supply space for: 2930543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - an F/W dependent number of bytes of Control Info field including the 802.11 Header field 2931543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - Destination Address 2932543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - Source Address 2933543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - Length field 2934543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - [ SNAP Header] 2935543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy* - [ Ethernet-II Type] 293668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* This results in 68 for Hermes-I and 80 for Hermes-II 293768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* This way the minimum amount of information is available needed by the HCF to determine whether the frame 293868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* must be decapsulated. 2939543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy*.ENDDOC END DOCUMENTATION 294068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot* 294168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot************************************************************************************************************/ 294268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 294368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groothcf_service_nic( IFBP ifbp, wci_bufp bufp, unsigned int len ) 294468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 294568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2946543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 2947543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 stat; 2948543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp buf_addr; 2949543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 295068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2951788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_SERVICE_NIC, ifbp->IFB_IntOffCnt ); 2952788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_Magic == HCF_MAGIC, ifbp->IFB_Magic ); 2953788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT_INT; 295468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 2955543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_LinkStat = 0; // ;? to be obsoleted ASAP /* 1*/ 2956543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DSLinkStat &= ~CFG_LINK_STAT_CHANGE; /* 1*/ 2957543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (void)hcf_action( ifbp, HCF_ACT_RX_ACK ); /* 2*/ 2958543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_CardStat == 0 && ( stat = IPW( HREG_EV_STAT ) ) != 0xFFFF ) { /* 4*/ 295968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* IF_NOT_DMA( HCFASSERT( !( stat & ~HREG_EV_BASIC_MASK, stat ) ) 296068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * IF_NOT_USE_DMA( HCFASSERT( !( stat & ~HREG_EV_BASIC_MASK, stat ) ) 296168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * IF_USE_DMA( HCFASSERT( !( stat & ~( HREG_EV_BASIC_MASK ^ ( HREG_EV_...DMA.... ), stat ) ) 296268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot */ 2963543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /* 8*/ 296468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_RscInd == 0 && stat & HREG_EV_ALLOC ) { //Note: IFB_RscInd is ALWAYS 1 for DMA 296568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RscInd = 1; 296668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 2967788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_TALLY( if ( stat & HREG_EV_INFO_DROP ) { ifbp->IFB_HCF_Tallies.NoBufInfo++; } ); 296868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_INT_TICK 296968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( stat & HREG_EV_TICK ) { 297068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_TickCnt++; 297168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 297268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if 0 // (HCF_SLEEP) & HCF_DDS 297368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_TickCnt == 3 && ( ifbp->IFB_DSLinkStat & CFG_LINK_STAT_CONNECTED ) == 0 ) { 2974543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_DDS_TICK_TIME_STRCT ltv; 297568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // 2 second period (with 1 tick uncertanty) in not-connected mode -->go into DS_OOR 297668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_action( ifbp, HCF_ACT_SLEEP ); 297768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_DSLinkStat |= CFG_LINK_STAT_DS_OOR; //set OutOfRange 297868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltv.len = 2; 297968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltv.typ = CFG_DDS_TICK_TIME; 298068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltv.tick_time = ( ( ifbp->IFB_DSLinkStat & CFG_LINK_STAT_TIMER ) + 0x10 ) *64; //78 is more right 298168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_put_info( ifbp, (LTVP)<v ); 298268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot printk( "<5>Preparing for sleep, link_status: %04X, timer : %d\n", 2983543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DSLinkStat, ltv.tick_time );//;?remove me 1 day 298468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_TickCnt++; //;?just to make sure we do not keep on printing above message 298568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltv.tick_time < 300 * 125 ) ifbp->IFB_DSLinkStat += 0x0010; 298668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 298768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 298868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DDS 298968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_INT_TICK 299068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( stat & HREG_EV_INFO ) { 299168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot isr_info( ifbp ); 299268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 299368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_INT_TX_EX 299468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( stat & HREG_EV_TX_EXT && ( i = IPW( HREG_TX_COMPL_FID ) ) != 0 /*DAWA*/ ) { 2995788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy DAWA_ZERO_FID( HREG_TX_COMPL_FID ); 299668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)setup_bap( ifbp, i, 0, IO_IN ); 299768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, &ifbp->IFB_TxFsStat, HFS_SWSUP BE_PAR(1) ); 299868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 299968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_INT_TX_EX 300068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//!rlav DMA engine will handle the rx event, not the driver 300168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 300268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( !( ifbp->IFB_CntlOpt & USE_DMA ) ) //!! be aware of the logical indentations 300368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 3004543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*16*/ if ( stat & HREG_EV_RX && ( ifbp->IFB_RxFID = IPW( HREG_RX_FID ) ) != 0 ) { //if 0 then DAWA_ACK 3005543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( bufp, len ); 3006543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( len >= HFS_DAT + 2, len ); 3007543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DAWA_ZERO_FID( HREG_RX_FID ); 3008543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( ifbp->IFB_RxFID < CFG_PROD_DATA, ifbp->IFB_RxFID); 3009543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy (void)setup_bap( ifbp, ifbp->IFB_RxFID, 0, IO_IN ); 3010543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy get_frag( ifbp, bufp, HFS_ADDR_DEST BE_PAR(1) ); 3011543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_lap = buf_addr = bufp + HFS_ADDR_DEST; 3012543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_RxLen = (hcf_16)(bufp[HFS_DAT_LEN] + (bufp[HFS_DAT_LEN+1]<<8) + 2*6 + 2); 3013543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*26*/ if ( ifbp->IFB_RxLen >= 22 ) { // convenient for MIC calculation (5 DWs + 1 "skipped" W) 3014543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. get DA,SA,Len/Type and (SNAP,Type or 8 data bytes) 3015543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*30*/ get_frag( ifbp, buf_addr, 22 BE_PAR(0) ); 3016543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*32*/ CALC_RX_MIC( bufp, -1 ); //. initialize MIC 3017543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_RX_MIC( buf_addr, HCF_DASA_SIZE ); //. MIC over DA, SA 3018543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_RX_MIC( null_addr, 4 ); //. MIC over (virtual) priority field 3019543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_RX_MIC( buf_addr+14, 8 ); //. skip Len, MIC over SNAP,Type or 8 data bytes) 3020543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy buf_addr += 22; 302168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ENCAP) == HCF_ENC 302289c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy HCFASSERT( len >= HFS_DAT + 2 + sizeof(snap_header), len ); 302389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy /*34*/ i = *(wci_recordp)&bufp[HFS_STAT] & ( HFS_STAT_MSG_TYPE | HFS_STAT_ERR ); 302489c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy if ( i == HFS_STAT_TUNNEL || 302589c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy ( i == HFS_STAT_1042 && hcf_encap( (wci_bufp)&bufp[HFS_TYPE] ) != ENC_TUNNEL ) ) { 3026543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. copy E-II Type to 802.3 LEN field 302789c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy /*36*/ bufp[HFS_LEN ] = bufp[HFS_TYPE ]; 302889c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy bufp[HFS_LEN+1] = bufp[HFS_TYPE+1]; 3029543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. discard Snap by overwriting with data 303089c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy ifbp->IFB_RxLen -= (HFS_TYPE - HFS_LEN); 303189c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy buf_addr -= ( HFS_TYPE - HFS_LEN ); // this happens to bring us at a DW boundary of 36 3032543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 303389c5be50e13f41e13d22f3462798ac729631f2c4David Kilroy#endif // HCF_ENC 303468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3035543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*40*/ ifbp->IFB_lal = min( (hcf_16)(len - HFS_ADDR_DEST), ifbp->IFB_RxLen ); 3036543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = ifbp->IFB_lal - ( buf_addr - ( bufp + HFS_ADDR_DEST ) ); 3037543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy get_frag( ifbp, buf_addr, i BE_PAR(0) ); 3038543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_RX_MIC( buf_addr, i ); 303968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 3040543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_lal == ifbp->IFB_RxLen ) { 3041543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = check_mic( ifbp ); 3042543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 304368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 3044543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*44*/ if ( len - HFS_ADDR_DEST >= ifbp->IFB_RxLen ) { 3045543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_RxFID = 0; 3046543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else { /* IFB_RxFID is cleared, so you do not get another Rx_Ack at next entry of hcf_service_nic */ 3047543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy stat &= (hcf_16)~HREG_EV_RX; //don't ack Rx if processing not yet completed 3048543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 304968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 305068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // in case of DMA: signal availability of rx and/or tx packets to MSF 3051788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_USE_DMA( ifbp->IFB_DmaPackets |= stat & ( HREG_EV_RDMAD | HREG_EV_TDMAD ) ); 305268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // rlav : pending HREG_EV_RDMAD or HREG_EV_TDMAD events get acknowledged here. 3053543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*54*/ stat &= (hcf_16)~( HREG_EV_SLEEP_REQ | HREG_EV_CMD | HREG_EV_ACK_REG_READY | HREG_EV_ALLOC | HREG_EV_FW_DMA ); 3054543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//a positive mask would be easier to understand /*54*/ stat &= (hcf_16)~( HREG_EV_SLEEP_REQ | HREG_EV_CMD | HREG_EV_ACK_REG_READY | HREG_EV_ALLOC | HREG_EV_FW_DMA ); 3055788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_USE_DMA( stat &= (hcf_16)~HREG_EV_RX ); 305668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( stat ) { 3057543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DAWA_ACK( stat ); /*DAWA*/ 305868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 305968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3060788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_SERVICE_NIC ); 306168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 306268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // hcf_service_nic 306368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 306468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 306568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3066543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************** H C F S U P P O R T R O U T I N E S ****************************************** 3067543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 306868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 306968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 307068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3071543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3072543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void calc_mic( hcf_32* p, hcf_32 m ) 3073543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE calculate MIC on a quad byte. 3074543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3075543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3076543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * p address of the MIC 3077543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * m 32 bit value to be processed by the MIC calculation engine 3078543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3079543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 3080543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3081543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3082543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * calc_mic is the implementation of the MIC algorithm. It is a monkey-see monkey-do copy of 3083543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Michael::appendByte() 3084543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of Appendix C of .......... 3085543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3086543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3087543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3088543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3089543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3090543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3091543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3092543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 309368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 309468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 309568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 309668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define ROL32( A, n ) ( ((A) << (n)) | ( ((A)>>(32-(n))) & ( (1UL << (n)) - 1 ) ) ) 309768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#define ROR32( A, n ) ROL32( (A), 32-(n) ) 309868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3099543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#define L *p 3100543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#define R *(p+1) 310168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 310268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 310368c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcalc_mic( hcf_32* p, hcf_32 m ) 310468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 310568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 310668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot m = (m >> 16) | (m << 16); 310768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 310868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot L ^= m; 310968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot R ^= ROL32( L, 17 ); 311068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot L += R; 311168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot R ^= ((L & 0xff00ff00) >> 8) | ((L & 0x00ff00ff) << 8); 311268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot L += R; 311368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot R ^= ROL32( L, 3 ); 311468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot L += R; 311568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot R ^= ROR32( L, 2 ); 311668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot L += R; 311768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // calc_mic 311868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef R 311968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#undef L 312068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 312168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 312268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 312368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 312468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 312568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3126543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3127543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void calc_mic_rx_frag( IFBP ifbp, wci_bufp p, int len ) 3128543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE calculate MIC on a single fragment. 3129543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3130543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3131543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3132543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bufp (byte) address of buffer 3133543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len length in bytes of buffer specified by bufp 3134543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3135543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 3136543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3137543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3138543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * calc_mic_rx_frag ........ 3139543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3140543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The MIC is located in the IFB. 3141543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The MIC is separate for Tx and Rx, thus allowing hcf_send_msg to occur between hcf_service_nic and 3142543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_rcv_msg. 3143543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3144543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3145543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3146543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3147543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3148543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3149543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3150543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 315168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 315268c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcalc_mic_rx_frag( IFBP ifbp, wci_bufp p, int len ) 315368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3154543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy static union { hcf_32 x32; hcf_16 x16[2]; hcf_8 x8[4]; } x; //* area to accumulate 4 bytes input for MIC engine 3155543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i; 315668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3157543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( len == -1 ) { //initialize MIC housekeeping 315868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = *(wci_recordp)&p[HFS_STAT]; 315968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /* i = CNV_SHORTP_TO_LITTLE(&p[HFS_STAT]); should not be neede to prevent alignment poroblems 316068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * since len == -1 if and only if p is lookahaead buffer which MUST be word aligned 316168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * to be re-investigated by NvR 316268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot */ 316368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 316468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ( i & HFS_STAT_MIC ) == 0 ) { 3165543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICRxCarry = 0xFFFF; //suppress MIC calculation 316668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 316768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRxCarry = 0; 3168543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//* Note that "coincidentally" the bit positions used in HFS_STAT 3169543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy//* correspond with the offset of the key in IFB_MICKey 3170543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy i = ( i & HFS_STAT_MIC_KEY_ID ) >> 10; /* coincidentally no shift needed for i itself */ 317168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRx[0] = CNV_LONG_TO_LITTLE(ifbp->IFB_MICRxKey[i ]); 317268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRx[1] = CNV_LONG_TO_LITTLE(ifbp->IFB_MICRxKey[i+1]); 317368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 317468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 317568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MICRxCarry == 0 ) { 317668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.x32 = CNV_LONGP_TO_LITTLE(p); 317768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += 4; 317868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len < 4 ) { 317968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRxCarry = (hcf_16)len; 318068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 318168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRxCarry = 4; 318268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 4; 318368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3184543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else while ( ifbp->IFB_MICRxCarry < 4 && len ) { //note for hcf_16 applies: 0xFFFF > 4 3185543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy x.x8[ifbp->IFB_MICRxCarry++] = *p++; 3186543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy len--; 3187543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3188543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy while ( ifbp->IFB_MICRxCarry == 4 ) { //contrived so we have only 1 call to calc_mic so we could bring it in-line 318968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot calc_mic( ifbp->IFB_MICRx, x.x32 ); 319068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.x32 = CNV_LONGP_TO_LITTLE(p); 319168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += 4; 319268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len < 4 ) { 319368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICRxCarry = (hcf_16)len; 319468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 319568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 4; 319668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 319768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 319868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // calc_mic_rx_frag 319968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 320068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 320168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 320268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 320368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3204543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3205543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void calc_mic_tx_frag( IFBP ifbp, wci_bufp p, int len ) 3206543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE calculate MIC on a single fragment. 3207543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3208543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3209543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3210543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bufp (byte) address of buffer 3211543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len length in bytes of buffer specified by bufp 3212543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3213543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 3214543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3215543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3216543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * calc_mic_tx_frag ........ 3217543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3218543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The MIC is located in the IFB. 3219543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The MIC is separate for Tx and Rx, thus allowing hcf_send_msg to occur between hcf_service_nic and 3220543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_rcv_msg. 3221543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3222543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3223543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3224543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3225543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3226543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3227543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3228543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 322968c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 323068c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcalc_mic_tx_frag( IFBP ifbp, wci_bufp p, int len ) 323168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3232543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy static union { hcf_32 x32; hcf_16 x16[2]; hcf_8 x8[4]; } x; //* area to accumulate 4 bytes input for MIC engine 323368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3234543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if initialization request 323568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len == -1 ) { 3236543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. presume MIC calculation disabled 323768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTxCarry = 0xFFFF; 3238543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if MIC calculation enabled 323968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MICTxCntl ) { 3240543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . clear MIC carry 324168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTxCarry = 0; 3242543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . initialize MIC-engine 3243543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MICTx[0] = CNV_LONG_TO_LITTLE(ifbp->IFB_MICTxKey[0]); /*Tx always uses Key 0 */ 324468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTx[1] = CNV_LONG_TO_LITTLE(ifbp->IFB_MICTxKey[1]); 324568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3246543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //else 324768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 3248543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if MIC enabled (Tx) / if MIC present (Rx) 3249543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. and no carry from previous calc_mic_frag 325068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MICTxCarry == 0 ) { 3251543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . preset accu with 4 bytes from buffer 325268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.x32 = CNV_LONGP_TO_LITTLE(p); 3253543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust pointer accordingly 325468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += 4; 3255543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . if buffer contained less then 4 bytes 325668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len < 4 ) { 3257543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . promote valid bytes in accu to carry 3258543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . flag accu to contain incomplete double word 325968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTxCarry = (hcf_16)len; 3260543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . else 326168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 3262543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . flag accu to contain complete double word 326368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTxCarry = 4; 3264543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust remaining buffer length 326568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 4; 326668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3267543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. else if MIC enabled 3268543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. and if carry bytes from previous calc_mic_tx_frag 3269543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . move (1-3) bytes from carry into accu 3270543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } else while ( ifbp->IFB_MICTxCarry < 4 && len ) { /* note for hcf_16 applies: 0xFFFF > 4 */ 3271543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy x.x8[ifbp->IFB_MICTxCarry++] = *p++; 3272543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy len--; 3273543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3274543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. while accu contains complete double word 3275543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. and MIC enabled 327668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( ifbp->IFB_MICTxCarry == 4 ) { 3277543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . pass accu to MIC engine 327868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot calc_mic( ifbp->IFB_MICTx, x.x32 ); 3279543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . copy next 4 bytes from buffer to accu 328068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot x.x32 = CNV_LONGP_TO_LITTLE(p); 3281543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust buffer pointer 328268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += 4; 3283543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . if buffer contained less then 4 bytes 3284543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . promote valid bytes in accu to carry 3285543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . flag accu to contain incomplete double word 328668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len < 4 ) { 328768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_MICTxCarry = (hcf_16)len; 328868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3289543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust remaining buffer length 329068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 4; 329168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 329268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 329368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // calc_mic_tx_frag 329468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 329568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 329668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 329768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_PROT_TIME 329868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3299543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3300543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void calibrate( IFBP ifbp ) 3301543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE calibrates the S/W protection counter against the Hermes Timer tick. 3302543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3303543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3304543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3305543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3306543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 3307543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3308543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3309543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * calibrates the S/W protection counter against the Hermes Timer tick 3310543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_TickIni is the value used to initialize the S/W protection counter such that the expiration period 3311543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * more or less independent of the processor speed. If IFB_TickIni is not yet calibrated, it is done now. 3312543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * This calibration is "reasonably" accurate because the Hermes is in a quiet state as a result of the 3313543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Initialize command. 3314543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3315543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3316543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3317543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3318543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: IFB_TickIni is initialized at INI_TICK_INI by hcf_connect. If calibrate succeeds, IFB_TickIni is 3319543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * guaranteed to be changed. As a consequence there will be only 1 shot at calibration (regardless of the 3320543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * number of init calls) under normal circumstances. 3321543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: Calibration is done HCF_PROT_TIME_CNT times. This diminish the effects of jitter and interference, 3322543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * especially in a pre-emptive environment. HCF_PROT_TIME_CNT is in the range of 16 through 32 and derived 3323543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * from the HCF_PROT_TIME specified by the MSF programmer. The divisor needed to scale HCF_PROT_TIME into the 3324543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 16-32 range, is used as a multiplicator after the calibration, to scale the found value back to the 3325543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * requested range. This way a compromise is achieved between accuracy and duration of the calibration 3326543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * process. 3327543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *3: Acknowledge the Timer Tick Event. 3328543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Each cycle is limited to at most INI_TICK_INI samples of the TimerTick status of the Hermes. 3329543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Since the start of calibrate is unrelated to the Hermes Internal Timer, the first interval may last from 0 3330543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to the normal interval, all subsequent intervals should be the full length of the Hermes Tick interval. 3331543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Hermes Timer Tick is not reprogrammed by the HCF, hence it is running at the default of 10 k 3332543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * microseconds. 3333543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: If the Timer Tick Event is continuously up (prot_cnt still has the value INI_TICK_INI) or no Timer Tick 3334543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Event occurred before the protection counter expired, reset IFB_TickIni to INI_TICK_INI, 3335543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * set the defunct bit of IFB_CardStat (thus rendering the Hermes inoperable) and exit the calibrate routine. 3336543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: ifbp->IFB_TickIni is multiplied to scale the found value back to the requested range as explained under 2. 3337543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3338543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3339543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o Although there are a number of viewpoints possible, calibrate() uses as error strategy that a single 3340543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * failure of the Hermes TimerTick is considered fatal. 3341543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o There is no hard and concrete time-out value defined for Hermes activities. The default 1 seconds is 3342543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * believed to be sufficiently "relaxed" for real life and to be sufficiently short to be still useful in an 3343543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * environment with humans. 3344543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o Note that via IFB_DefunctStat time outs in cmd_wait and in hcfio_string block all Hermes access till the 3345543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * next init so functions which call a mix of cmd_wait and hcfio_string only need to check the return status 3346543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of the last call 3347543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * o The return code is preset at Time out. 3348543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The additional complication that no calibrated value for the protection count can be assumed since 3349543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * calibrate() does not yet have determined a calibrated value (a catch 22), is handled by setting the 3350543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * initial value at INI_TICK_INI (by hcf_connect). This approach is considered safe, because: 3351543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the HCF does not use the pipeline mechanism of Hermes commands. 3352543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the likelihood of failure (the only time when protection count is relevant) is small. 3353543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the time will be sufficiently large on a fast machine (busy bit drops on good NIC before counter 3354543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * expires) 3355543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the time will be sufficiently small on a slow machine (counter expires on bad NIC before the end user 3356543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * switches the power off in despair 3357543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The time needed to wrap a 32 bit counter around is longer than many humans want to wait, hence the more or 3358543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * less arbitrary value of 0x40000L is chosen, assuming it does not take too long on an XT and is not too 3359543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * short on a scream-machine. 3360543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3361543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3362543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3363543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 336468c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 336568c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcalibrate( IFBP ifbp ) 336668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3367543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int cnt = HCF_PROT_TIME_CNT; 3368543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 prot_cnt; 336968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 337068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFTRACE( ifbp, HCF_TRACE_CALIBRATE ); 3371543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_TickIni == INI_TICK_INI ) { /*1*/ 3372543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TickIni = 0; /*2*/ 3373543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy while ( cnt-- ) { 3374543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy prot_cnt = INI_TICK_INI; 3375543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_EV_ACK, HREG_EV_TICK ); /*3*/ 3376543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy while ( (IPW( HREG_EV_STAT ) & HREG_EV_TICK) == 0 && --prot_cnt ) { 3377543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TickIni++; 3378543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3379543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( prot_cnt == 0 || prot_cnt == INI_TICK_INI ) { /*4*/ 3380543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TickIni = INI_TICK_INI; 3381543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DefunctStat = HCF_ERR_DEFUNCT_TIMER; 3382543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CardStat |= CARD_STAT_DEFUNCT; 3383543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( DO_ASSERT, prot_cnt ); 338468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3385543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3386543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_TickIni <<= HCF_PROT_TIME_SHFT; /*8*/ 338768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 338868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFTRACE( ifbp, HCF_TRACE_CALIBRATE | HCF_TRACE_EXIT ); 338968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // calibrate 339068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_PROT_TIME 339168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 339268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 339368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 339468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3395543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3396543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int check_mic( IFBP ifbp ) 3397543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE verifies the MIC of a received non-USB frame. 3398543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3399543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3400543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3401543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3402543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3403543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 3404543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_MIC 3405543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3406543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3407543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3408543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3409543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3410543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3411543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: test whether or not a MIC is reported by the Hermes 3412543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *14: the calculated MIC and the received MIC are compared, the return status is set when there is a mismatch 3413543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3414543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3415543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3416543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3417543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 341868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootint 341968c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcheck_mic( IFBP ifbp ) 342068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3421543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 3422543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 x32[2]; //* area to save rcvd 8 bytes MIC 342368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3424543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if MIC present in RxFS 342568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( *(wci_recordp)&ifbp->IFB_lap[-HFS_ADDR_DEST] & HFS_STAT_MIC ) { 3426543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //or if ( ifbp->IFB_MICRxCarry != 0xFFFF ) 3427543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_RX_MIC( mic_pad, 8 ); //. process up to 3 remaining bytes of data and append 5 to 8 bytes of padding to MIC calculation 342868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, (wci_bufp)x32, 8 BE_PAR(0));//. get 8 byte MIC from NIC 3429543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if calculated and received MIC do not match 3430543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . set status at HCF_ERR_MIC 3431543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*14*/ if ( x32[0] != CNV_LITTLE_TO_LONG(ifbp->IFB_MICRx[0]) || 3432543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy x32[1] != CNV_LITTLE_TO_LONG(ifbp->IFB_MICRx[1]) ) { 343368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_MIC; 343468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 343568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3436543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //return status 343768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 343868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // check_mic 343968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 344068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 344168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 344268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3443543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3444543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int cmd_cmpl( IFBP ifbp ) 3445543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE waits for Hermes Command Completion. 3446543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3447543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3448543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3449543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3450543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3451543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_DefunctStat 3452543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT 3453543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_CMD_SEQ 3454543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 3455543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3456543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3457543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3458543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3459543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3460543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3461543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: Once cmd_cmpl is called, the Busy option bit in IFB_Cmd must be cleared 3462543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: If Status register and command code don't match either: 3463543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the Hermes and Host are out of sync ( a fatal error) 3464543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - error bits are reported via the Status Register. 3465543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Out of sync is considered fatal and brings the HCF in Defunct mode 3466543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Errors reported via the Status Register should be caused by sequence violations in Hermes command 3467543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * sequences and hence these bugs should have been found during engineering testing. Since there is no 3468543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * strategy to cope with this problem, it might as well be ignored at run time. Note that for any particular 3469543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * situation where a strategy is formulated to handle the consequences of a particular bug causing a 3470543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * particular Error situation reported via the Status Register, the bug should be removed rather than adding 3471543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * logic to cope with the consequences of the bug. 3472543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * There have been HCF versions where an error report via the Status Register even brought the HCF in defunct 3473543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * mode (although it was not yet named like that at that time). This is particular undesirable behavior for a 3474543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * general library. 3475543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Simply reporting the error (as "interesting") is debatable. There also have been HCF versions with this 3476543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * strategy using the "vague" HCF_FAILURE code. 3477543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The error is reported via: 3478543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - MiscErr tally of the HCF Tally set 3479543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the (informative) fields IFB_ErrCmd and IFB_ErrQualifier 3480543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the assert mechanism 3481543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: Here the Defunct case and the Status error are separately treated 3482543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3483543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3484543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3485543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3486543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 348768c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 348868c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootcmd_cmpl( IFBP ifbp ) 348968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 349068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3491543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy PROT_CNT_INI; 3492543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 3493543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 stat; 349468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3495788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_CMD_CPL, ifbp->IFB_Cmd ); 3496543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_Cmd &= ~HCMD_BUSY; /* 2 */ 3497543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCF_WAIT_WHILE( (IPW( HREG_EV_STAT) & HREG_EV_CMD) == 0 ); /* 4 */ 349868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot stat = IPW( HREG_STAT ); 349968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_PROT_TIME 350068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( prot_cnt == 0 ) { 3501788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_TALLY( ifbp->IFB_HCF_Tallies.MiscErr++ ); 350268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_TIME_OUT; 3503788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, ifbp->IFB_Cmd ); 350468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else 350568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_PROT_TIME 350668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 350768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot DAWA_ACK( HREG_EV_CMD ); 3508543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*4*/ if ( stat != (ifbp->IFB_Cmd & HCMD_CMD_CODE) ) { 3509543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*8*/ if ( ( (stat ^ ifbp->IFB_Cmd ) & HCMD_CMD_CODE) != 0 ) { 351068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = ifbp->IFB_DefunctStat = HCF_ERR_DEFUNCT_CMD_SEQ; 351168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CardStat |= CARD_STAT_DEFUNCT; 351268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3513788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_TALLY( ifbp->IFB_HCF_Tallies.MiscErr++ ); 351468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_ErrCmd = stat; 351568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_ErrQualifier = IPW( HREG_RESP_0 ); 3516788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, MERGE_2( IPW( HREG_PARAM_0 ), ifbp->IFB_Cmd ) ); 3517788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, MERGE_2( ifbp->IFB_ErrQualifier, ifbp->IFB_ErrCmd ) ); 351868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 351968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3520543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( rc == HCF_SUCCESS, rc); 3521543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFLOGEXIT( HCF_TRACE_CMD_CPL ); 3522543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy return rc; 3523543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy} // cmd_cmpl 3524543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 3525543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy 3526543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy/************************************************************************************************************ 3527543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3528543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int cmd_exe( IFBP ifbp, int cmd_code, int par_0 ) 3529543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Executes synchronous part of Hermes Command and - optionally - waits for Command Completion. 3530543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3531543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3532543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3533543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * cmd_code 3534543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * par_0 3535543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3536543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3537543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_DefunctStat 3538543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_CMD_SEQ 3539543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 3540543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TO_BE_ADDED <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< 3541543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3542543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3543543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Executes synchronous Hermes Command and waits for Command Completion 3544543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3545543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The general HCF strategy is to wait for command completion. As a consequence: 3546543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the read of the busy bit before writing the command register is superfluous 3547543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the Hermes requirement that no Inquiry command may be executed if there is still an unacknowledged 3548543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Inquiry command outstanding, is automatically met. 3549543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The Tx command uses the "Busy" bit in the cmd_code parameter to deviate from this general HCF strategy. 3550543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The idea is that by not busy-waiting on completion of this frequently used command the processor 3551543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * utilization is diminished while using the busy-wait on all other seldom used commands the flow is kept 3552543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * simple. 3553543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3554543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3555543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3556543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3557543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3558543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: skip the body of cmd_exe when in defunct mode or when - based on the S/W Support register write and 3559543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * read back test - there is apparently no NIC. 3560543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: we gave up on the "old" strategy to write the S/W Support register at magic only when needed. Due to 3561543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the intricateness of Hermes F/W varieties ( which behave differently as far as corruption of the S/W 3562543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Support register is involved), the increasing number of Hermes commands which do an implicit initialize 3563543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * (thus modifying the S/W Support register) and the workarounds of some OS/Support S/W induced aspects (e.g. 3564543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the System Soft library at WinNT which postpones the actual mapping of I/O space up to 30 seconds after 3565543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * giving the go-ahead), the "magic" strategy is now reduced to a simple write and read back. This means that 3566543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * problems like a bug tramping over the memory mapped Hermes registers will no longer be noticed as side 3567543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * effect of the S/W Support register check. 3568543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: check whether the preceding command skipped the busy wait and if so, check for command completion 3569543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3570543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3571543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3572543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3573543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 357468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 357568c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 3576543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroycmd_exe( IFBP ifbp, hcf_16 cmd_code, hcf_16 par_0 ) //if HCMD_BUSY of cmd_code set, then do NOT wait for completion 357768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3578543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc; 357968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3580788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_CMD_EXE, cmd_code ); 3581788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( (cmd_code & HCMD_CMD_CODE) != HCMD_TX || cmd_code & HCMD_BUSY, cmd_code ); //Tx must have Busy bit set 358268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_SW_0, HCF_MAGIC ); 3583543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( IPW( HREG_SW_0 ) == HCF_MAGIC ) { /* 1 */ 358468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = ifbp->IFB_DefunctStat; 358568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 358668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot else rc = HCF_ERR_NO_NIC; 358768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( rc == HCF_SUCCESS ) { 358868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //;?is this a hot idea, better MEASURE performance impact 3589543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*2*/ if ( ifbp->IFB_Cmd & HCMD_BUSY ) { 359068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_cmpl( ifbp ); 359168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 359268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_PARAM_0, par_0 ); 359368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_CMD, cmd_code &~HCMD_BUSY ); 359468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_Cmd = cmd_code; 3595543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( (cmd_code & HCMD_BUSY) == 0 ) { //;?is this a hot idea, better MEASURE performance impact 359668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_cmpl( ifbp ); 359768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 359868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3599788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( rc == HCF_SUCCESS, MERGE_2( rc, cmd_code ) ); 3600788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_CMD_EXE ); 360168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 360268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // cmd_exe 360368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 360468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 360568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3606543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3607543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int download( IFBP ifbp, CFG_PROG_STRCT FAR *ltvp ) 3608543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE downloads F/W image into NIC and initiates execution of the downloaded F/W. 3609543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3610543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3611543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3612543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ltvp specifies the pseudo-RID (as defined by WCI) 3613543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3614543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3615543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3616543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3617543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3618543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3619543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3620543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: First, Ack everything to unblock a (possibly) blocked cmd pipe line 3621543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 1: it is very likely that an Alloc event is pending and very well possible that a (Send) Cmd event is 3622543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pending 3623543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note 2: it is assumed that this strategy takes away the need to ack every conceivable event after an 3624543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Hermes Initialize 3625543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3626543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3627543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3628543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3629543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 363068c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 3631543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroydownload( IFBP ifbp, CFG_PROG_STRCT FAR *ltvp ) //Hermes-II download (volatile only) 363268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3633543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; 3634543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 3635543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp cp; 3636543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_io io_port = ifbp->IFB_IOBase + HREG_AUX_DATA; 363768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3638788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_DL, ltvp->typ ); 363968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_PRELOADED 3640788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, ltvp->mode ); 364168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#else 3642543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if initial "program" LTV 364368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_DLMode == CFG_PROG_STOP && ltvp->mode == CFG_PROG_VOLATILE) { 3644543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. switch Hermes to initial mode 3645543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*1*/ OPW( HREG_EV_ACK, ~HREG_EV_SLEEP_REQ ); 3646543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = cmd_exe( ifbp, HCMD_INI, 0 ); /* HCMD_INI can not be part of init() because that is called on 3647543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * other occasions as well */ 364868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = init( ifbp ); 364968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3650543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if final "program" LTV 365168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltvp->mode == CFG_PROG_STOP && ifbp->IFB_DLMode == CFG_PROG_VOLATILE) { 3652543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. start tertiary (or secondary) 365368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_PARAM_1, (hcf_16)(ltvp->nic_addr >> 16) ); 365468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_exe( ifbp, HCMD_EXECUTE, (hcf_16) ltvp->nic_addr ); 365568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if (rc == HCF_SUCCESS) { 3656543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy rc = init( ifbp ); /*;? do we really want to skip init if cmd_exe failed, i.e. 3657543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * IFB_FW_Comp_Id is than possibly incorrect */ 3658543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3659543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //else (non-final) 366068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 3661543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if mode == Readback SEEPROM 3662543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if 0 //;? as long as the next if contains a hard coded 0, might as well leave it out even more obvious 366368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( 0 /*len is definitely not want we want;?*/ && ltvp->mode == CFG_PROG_SEEPROM_READBACK ) { 366468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_PARAM_1, (hcf_16)(ltvp->nic_addr >> 16) ); 366585d5cb15b3a75ca029be34af76fda7d0e081af44David Kilroy OPW( HREG_PARAM_2, (hcf_16)((ltvp->len - 4) << 1) ); 3666543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . perform Hermes prog cmd with appropriate mode bits 366768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_exe( ifbp, HCMD_PROGRAM | ltvp->mode, (hcf_16)ltvp->nic_addr ); 3668543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . set up NIC RAM addressability according Resp0-1 366968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_PAGE, IPW( HREG_RESP_1) ); 367068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_OFFSET, IPW( HREG_RESP_0) ); 3671543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . set up L-field of LTV according Resp2 367268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = ( IPW( HREG_RESP_2 ) + 1 ) / 2; // i contains max buffer size in words, a probably not very useful piece of information ;? 367368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/*Nico's code based on i is the "real amount of data available" 367468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltvp->len - 4 < i ) rc = HCF_ERR_LEN; 367568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot else ltvp->len = i + 4; 367668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*/ 367768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* Rolands code based on the idea that a MSF should not ask for more than is available 367868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot // check if number of bytes requested exceeds max buffer size 367968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltvp->len - 4 > i ) { 368068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_LEN; 368168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ltvp->len = i + 4; 368268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 368368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot*/ 3684543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . copy data from NIC via AUX port to LTV 3685543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy cp = (wci_bufp)ltvp->host_addr; /*IN_PORT_STRING_8_16 macro may modify its parameters*/ 368668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = ltvp->len - 4; 3687543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy IN_PORT_STRING_8_16( io_port, cp, i ); //!!!WORD length, cp MUST be a char pointer // $$ char 3688543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. else (non-final programming) 368968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else 369068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif //;? as long as the above if contains a hard coded 0, might as well leave it out even more obvious 3691543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { //. . get number of words to program 3692788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ltvp->segment_size, *ltvp->host_addr ); 369368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = ltvp->segment_size/2; 3694543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . copy data (words) from LTV via AUX port to NIC 3695543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy cp = (wci_bufp)ltvp->host_addr; //OUT_PORT_STRING_8_16 macro may modify its parameters 3696543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . if mode == volatile programming 369768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ltvp->mode == CFG_PROG_VOLATILE ) { 3698543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . set up NIC RAM addressability via AUX port 369968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_PAGE, (hcf_16)(ltvp->nic_addr >> 16 << 9 | (ltvp->nic_addr & 0xFFFF) >> 7 ) ); 370068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_AUX_OFFSET, (hcf_16)(ltvp->nic_addr & 0x007E) ); 3701543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OUT_PORT_STRING_8_16( io_port, cp, i ); //!!!WORD length, cp MUST be a char pointer 370268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 370368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 370468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3705543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DLMode = ltvp->mode; //save state in IFB_DLMode 370668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_PRELOADED 3707788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( rc == HCF_SUCCESS, rc ); 3708788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_DL ); 370968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 371068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // download 371168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 371268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 371368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_PRINTF 371468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************** 3715543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Certain Hermes-II firmware versions can generate 3716543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * debug information. This debug information is 3717543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * contained in a buffer in nic-RAM, and can be read 3718543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * via the aux port. 3719543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy **************************************************/ 372068c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 372168c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootfw_printf(IFBP ifbp, CFG_FW_PRINTF_STRCT FAR *ltvp) 372268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3723543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 3724543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 fw_cnt; 3725543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// hcf_32 DbMsgBuffer = 0x29D2, DbMsgCount= 0x000029D0; 3726543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// hcf_16 DbMsgSize=0x00000080; 3727543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 DbMsgBuffer; 3728543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CFG_FW_PRINTF_BUFFER_LOCATION_STRCT *p = &ifbp->IFB_FwPfBuff; 3729543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->len = 1; 3730543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( p->DbMsgSize != 0 ) { 3731543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // first, check the counter in nic-RAM and compare it to the latest counter value of the HCF 3732543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_AUX_PAGE, (hcf_16)(p->DbMsgCount >> 7) ); 3733543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_AUX_OFFSET, (hcf_16)(p->DbMsgCount & 0x7E) ); 3734543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy fw_cnt = ((IPW( HREG_AUX_DATA) >>1 ) & ((hcf_16)p->DbMsgSize - 1)); 3735543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( fw_cnt != ifbp->IFB_DbgPrintF_Cnt ) { 3736543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// DbgPrint("fw_cnt=%d IFB_DbgPrintF_Cnt=%d\n", fw_cnt, ifbp->IFB_DbgPrintF_Cnt); 3737543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DbMsgBuffer = p->DbMsgBuffer + ifbp->IFB_DbgPrintF_Cnt * 6; // each entry is 3 words 3738543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_AUX_PAGE, (hcf_16)(DbMsgBuffer >> 7) ); 3739543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_AUX_OFFSET, (hcf_16)(DbMsgBuffer & 0x7E) ); 3740543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->msg_id = IPW(HREG_AUX_DATA); 3741543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->msg_par = IPW(HREG_AUX_DATA); 3742543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->msg_tstamp = IPW(HREG_AUX_DATA); 3743543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ltvp->len = 4; 3744543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DbgPrintF_Cnt++; 3745543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_DbgPrintF_Cnt &= (p->DbMsgSize - 1); 3746543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3747543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 3748543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy return rc; 374968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot}; 375068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_PRINTF 375168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 375268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 375368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3754543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3755543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE hcf_16 get_fid( IFBP ifbp ) 3756543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE get allocated FID for either transmit or notify. 3757543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3758543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3759543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3760543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3761543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3762543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 0 no FID available 3763543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * <>0 FID number 3764543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3765543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3766543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3767543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3768543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3769543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The preference is to use a "pending" alloc. If no alloc is pending, then - if available - the "spare" FID 3770543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is used. 3771543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the spare FID is used, IFB_RscInd (representing the spare FID) must be cleared 3772543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the pending alloc is used, the alloc event must be acknowledged to the Hermes. 3773543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case the spare FID was depleted and the IFB_RscInd has been "faked" as pseudo resource with a 0x0001 3774543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * value by hcf_service_nic, IFB_RscInd has to be "corrected" again to its 0x0000 value. 3775543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3776543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that due to the Hermes-II H/W problems which are intended to be worked around by DAWA, the Alloc bit 3777543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in the Event register is no longer a reliable indication of the presence/absence of a FID. The "Clear FID" 3778543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * part of the DAWA logic, together with the choice of the definition of the return information from get_fid, 3779543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * handle this automatically, i.e. without additional code in get_fid. 3780543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3781543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3782543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 378368c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC hcf_16 378468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootget_fid( IFBP ifbp ) 378568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 378668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3787543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 fid = 0; 378868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_HII5 ) == 0 3789543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy PROT_CNT_INI; 379068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_HII5 379168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3792788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_DMA( HCFASSERT(!(ifbp->IFB_CntlOpt & USE_DMA), ifbp->IFB_CntlOpt) ); 379368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 379468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( IPW( HREG_EV_STAT) & HREG_EV_ALLOC) { 379568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fid = IPW( HREG_ALLOC_FID ); 3796788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( fid, ifbp->IFB_RscInd ); 3797788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy DAWA_ZERO_FID( HREG_ALLOC_FID ); 379868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_HII5 ) == 0 379968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( ( IPW( HREG_EV_STAT ) & HREG_EV_ACK_REG_READY ) == 0 ); 3800788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( prot_cnt, IPW( HREG_EV_STAT ) ); 380168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_HII5 3802543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy DAWA_ACK( HREG_EV_ALLOC ); //!!note that HREG_EV_ALLOC is written only once 380368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 180 degree error in logic ;? #if ALLOC_15 380468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_RscInd == 1 ) { 380568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RscInd = 0; 380668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 380768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//#endif // ALLOC_15 380868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 380968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 180 degree error in logic ;? #if ALLOC_15 381068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fid = ifbp->IFB_RscInd; 381168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//#endif // ALLOC_15 381268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RscInd = 0; 381368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 381468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return fid; 381568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // get_fid 381668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 381768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 381868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3819543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3820543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void get_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ) 3821543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE reads with 16/32 bit I/O via BAP1 port from NIC RAM to Host memory. 3822543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3823543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3824543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3825543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bufp (byte) address of buffer 3826543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len length in bytes of buffer specified by bufp 3827543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * word_len Big Endian only: number of leading bytes to swap in pairs 3828543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3829543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 3830543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3831543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3832543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * process the single byte (if applicable) read by the previous get_frag and copy len (or len-1) bytes from 3833543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * NIC to bufp. 3834543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * On a Big Endian platform, the parameter word_len controls the number of leading bytes whose endianess is 3835543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * converted (i.e. byte swapped) 3836543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3837543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3838543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3839543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *10: The PCMCIA card can be removed in the middle of the transfer. By depositing a "magic number" in the 3840543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HREG_SW_0 register of the Hermes at initialization time and by verifying this register, it can be 3841543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * determined whether the card is still present. The return status is set accordingly. 3842543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Clearing the buffer is a (relative) cheap way to prevent that failing I/O results in run-away behavior 3843543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * because the garbage in the buffer is interpreted by the caller irrespective of the return status (e.g. 3844543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_service_nic has this behavior). 3845543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3846543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 3847543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * It turns out DOS ODI uses zero length fragments. The HCF code can cope with it, but as a consequence, no 3848543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert on len is possible 3849543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3850543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 3851543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3852543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 385368c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 385468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootget_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ) 385568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 3856543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_io io_port = ifbp->IFB_IOBase + HREG_DATA_1; //BAP data register 3857543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_bufp p = bufp; //working pointer 3858543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i; //prevent side effects from macro 3859543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int j; 386068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3861788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)bufp & (HCF_ALIGN-1) ) == 0, (hcf_32)bufp ); 386268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 3863543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy/*1: here recovery logic for intervening BAP access between hcf_service_nic and hcf_rcv_msg COULD be added 3864543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * if current access is RxInitial 3865543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * . persistent_offset += len 386668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot */ 386768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 386868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = len; 3869543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if buffer length > 0 and carry from previous get_frag 387068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i && ifbp->IFB_CarryIn ) { 3871543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. move carry to buffer 3872543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. adjust buffer length and pointer accordingly 387368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *p++ = (hcf_8)(ifbp->IFB_CarryIn>>8); 387468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i--; 3875543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. clear carry flag 387668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CarryIn = 0; 387768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 387868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_IO) & HCF_IO_32BITS 387968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //skip zero-length I/O, single byte I/O and I/O not worthwhile (i.e. less than 6 bytes)for DW logic 3880543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if buffer length >= 6 and 32 bits I/O support 388168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( !(ifbp->IFB_CntlOpt & USE_16BIT) && i >= 6 ) { 3882543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 FAR *p4; //prevent side effects from macro 3883543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( (hcf_32)p & 0x1 ) == 0 ) { //. if buffer at least word aligned 3884543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( (hcf_32)p & 0x2 ) { //. . if buffer not double word aligned 3885543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . read single word to get double word aligned 388668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot *(wci_recordp)p = IN_PORT_WORD( io_port ); 3887543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . adjust buffer length and pointer accordingly 388868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += 2; 388968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i -= 2; 389068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 3891543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . read as many double word as possible 389268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p4 = (hcf_32 FAR *)p; 389368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = i/4; 389468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot IN_PORT_STRING_32( io_port, p4, j ); 3895543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust buffer length and pointer accordingly 389668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p += i & ~0x0003; 389768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i &= 0x0003; 389868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 389968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 390068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_IO_32BITS 3901543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if no 32-bit support OR byte aligned OR 1-3 bytes left 390268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i ) { 3903543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. read as many word as possible in "alignment safe" way 390468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = i/2; 390568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot IN_PORT_STRING_8_16( io_port, p, j ); 3906543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if 1 byte left 390768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i & 0x0001 ) { 3908543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . read 1 word 390968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CarryIn = IN_PORT_WORD( io_port ); 3910543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . store LSB in last char of buffer 391168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp[len-1] = (hcf_8)ifbp->IFB_CarryIn; 3912543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . save MSB in carry, set carry flag 391368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CarryIn |= 0x1; 391468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 391568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 391668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 3917788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len == 0 || word_len == 2 || word_len == 4, word_len ); 3918788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len == 0 || ((hcf_32)bufp & 1 ) == 0, (hcf_32)bufp ); 3919788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len <= len, MERGE2( word_len, len ) ); 392025985edcedea6396277003854657b5f3cb31a628Lucas De Marchi //see put_frag for an alternative implementation, but be careful about what are int's and what are 392168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //hcf_16's 3922543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( word_len ) { //. if there is anything to convert 3923543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_8 c; 3924543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy c = bufp[1]; //. . convert the 1st hcf_16 392568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp[1] = bufp[0]; 392668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp[0] = c; 3927543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( word_len > 1 ) { //. . if there is to convert more than 1 word ( i.e 2 ) 3928543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy c = bufp[3]; //. . . convert the 2nd hcf_16 392968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp[3] = bufp[2]; 393068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp[2] = c; 393168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 393268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 393368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 393468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // get_frag 393568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 393668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 3937543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3938543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int init( IFBP ifbp ) 3939543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE Handles common initialization aspects (H-I init, calibration, config.mngmt, allocation). 3940543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3941543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 3942543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 3943543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3944543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 3945543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_INCOMP_PRI 3946543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_INCOMP_FW 3947543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_TIME_OUT 3948543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * >>hcf_get_info 3949543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC 3950543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_LEN 3951543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3952543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 3953543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * init will successively: 3954543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case of a (non-preloaded) H-I, initialize the NIC 3955543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - calibrate the S/W protection timer against the Hermes Timer 3956543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - collect HSI, "active" F/W Configuration Management Information 3957543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case active F/W is Primary F/W: collect Primary F/W Configuration Management Information 3958543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - check HSI and Primary F/W compatibility with the HCF 3959543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case active F/W is Station or AP F/W: check Station or AP F/W compatibility with the HCF 3960543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - in case active F/W is not Primary F/W: allocate FIDs to be used in transmit/notify process 3961543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3962543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 3963543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 3964543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: drop all error status bits in IFB_CardStat since they are expected to be re-evaluated. 3965543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: Ack everything except HREG_EV_SLEEP_REQ. It is very likely that an Alloc event is pending and 3966543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * very well possible that a Send Cmd event is pending. Acking HREG_EV_SLEEP_REQ is handled by hcf_action( 3967543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ACT_INT_ON ) !!! 3968543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *10: Calibrate the S/W time-out protection mechanism by calling calibrate(). Note that possible errors 3969543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in the calibration process are nor reported by init but will show up via the defunct mechanism in 3970543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * subsequent hcf-calls. 3971543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *14: usb_check_comp() is called to have the minimal visual clutter for the legacy H-I USB dongle 3972543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * compatibility check. 3973543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *16: The following configuration management related information is retrieved from the NIC: 3974543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - HSI supplier 3975543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - F/W Identity 3976543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - F/W supplier 3977543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * if appropriate: 3978543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - PRI Identity 3979543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - PRI supplier 3980543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * appropriate means on H-I: always 3981543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and on H-II if F/W supplier reflects a primary (i.e. only after an Hermes Reset or Init 3982543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * command). 3983543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * QUESTION ;? !!!!!! should, For each of the above RIDs the Endianess is converted to native Endianess. 3984543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Only the return code of the first hcf_get_info is used. All hcf_get_info calls are made, regardless of 3985543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the success or failure of the 1st hcf_get_info. The assumptions are: 3986543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - if any call fails, they all fail, so remembering the result of the 1st call is adequate 3987543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a failing call will overwrite the L-field with a 0x0000 value, which services both as an 3988543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * error indication for the values cached in the IFB as making mmd_check_comp fail. 3989543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of H-I, when getting the F/W identity fails, the F/W is assumed to be H-I AP F/W pre-dating 3990543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * version 9.0 and the F/W Identity and Supplier are faked accordingly. 3991543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In case of H-II, the Primary, Station and AP Identity are merged into a single F/W Identity. 3992543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The same applies to the Supplier information. As a consequence the PRI information can no longer be 3993543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * retrieved when a Tertiary runs. To accommodate MSFs and Utilities who depend on PRI information being 3994543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * available at any time, this information is cached in the IFB. In this cache the generic "F/W" value of 3995543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the typ-fields is overwritten with the specific (legacy) "PRI" values. To actually re-route the (legacy) 3996543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * PRI request via hcf_get_info, the xxxx-table must be set. In case of H-I, this caching, modifying and 3997543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * re-routing is not needed because PRI information is always available directly from the NIC. For 3998543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * consistency the caching fields in the IFB are filled with the PRI information anyway. 3999543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *18: mdd_check_comp() is called to check the Supplier Variant and Range of the Host-S/W I/F (HSI) and the 4000543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Primary Firmware Variant and Range against the Top and Bottom level supported by this HCF. If either of 4001543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * these tests fails, the CARD_STAT_INCOMP_PRI bit of IFB_CardStat is set 4002543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: There should always be a primary except during production, so this makes the HCF in its current form 4003543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * unsuitable for manufacturing test systems like the FTS. This can be remedied by an adding a test like 4004543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp->IFB_PRISup.id == COMP_ID_PRI 4005543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *20: In case there is Tertiary F/W and this F/W is Station F/W, the Supplier Variant and Range of the Station 4006543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Firmware function as retrieved from the Hermes is checked against the Top and Bottom level supported by 4007543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * this HCF. 4008543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: ;? the tertiary F/W compatibility checks could be moved to the DHF, which already has checked the 4009543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * CFI and MFI compatibility of the image with the NIC before the image was downloaded. 4010543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *28: In case of non-Primary F/W: allocates and acknowledge a (TX or Notify) FID and allocates without 4011543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * acknowledge another (TX or Notify) FID (the so-called 1.5 alloc scheme) with the following steps: 4012543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - execute the allocate command by calling cmd_exe 4013543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - wait till either the alloc event or a time-out occurs 4014543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - regardless whether the alloc event occurs, call get_fid to 4015543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - read the FID and save it in IFB_RscInd to be used as "spare FID" 4016543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - acknowledge the alloc event 4017543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - do another "half" allocate to complete the "1.5 Alloc scheme" 4018543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that above 3 steps do not harm and thus give the "cheapest" acceptable strategy. 4019543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If a time-out occurred, then report time out status (after all) 4020543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4021543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4022543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4023543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 402468c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 402568c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootinit( IFBP ifbp ) 402668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 402768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4028543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 402968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4030788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGENTRY( HCF_TRACE_INIT, 0 ); 403168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4032543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CardStat = 0; /* 2*/ 4033543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_EV_ACK, ~HREG_EV_SLEEP_REQ ); /* 4*/ 4034543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy IF_PROT_TIME( calibrate( ifbp ) ); /*10*/ 403568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if 0 // OOR 4036543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_FWIdentity.len = 2; //misuse the IFB space for a put 403768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.typ = CFG_TICK_TIME; 4038543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_FWIdentity.comp_id = (1000*1000)/1024 + 1; //roughly 1 second 403968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_put_info( ifbp, (LTVP)&ifbp->IFB_FWIdentity.len ); 404068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // OOR 404168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.len = sizeof(CFG_FW_IDENTITY_STRCT)/sizeof(hcf_16) - 1; 404268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.typ = CFG_FW_IDENTITY; 404368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = hcf_get_info( ifbp, (LTVP)&ifbp->IFB_FWIdentity.len ); 404468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* ;? conversion should not be needed for mmd_check_comp */ 404568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 404668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.comp_id = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWIdentity.comp_id ); 404768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.variant = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWIdentity.variant ); 404868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.version_major = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWIdentity.version_major ); 404968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWIdentity.version_minor = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWIdentity.version_minor ); 405068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 4051543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if defined MSF_COMPONENT_ID /*14*/ 4052543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( rc == HCF_SUCCESS ) { /*16*/ 405368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.len = sizeof(CFG_SUP_RANGE_STRCT)/sizeof(hcf_16) - 1; 405468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.typ = CFG_NIC_HSI_SUP_RANGE; 405568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = hcf_get_info( ifbp, (LTVP)&ifbp->IFB_HSISup.len ); 405668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* ;? conversion should not be needed for mmd_check_comp , BUT according to a report of a BE-user it is 405768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * should be resolved in the WARP release 405868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * since some compilers make ugly but unnecessary code of these instructions even for LE, 405968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * it is conditionally compiled */ 406068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 406168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.role = CNV_LITTLE_TO_SHORT( ifbp->IFB_HSISup.role ); 406268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.id = CNV_LITTLE_TO_SHORT( ifbp->IFB_HSISup.id ); 406368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.variant = CNV_LITTLE_TO_SHORT( ifbp->IFB_HSISup.variant ); 406468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.bottom = CNV_LITTLE_TO_SHORT( ifbp->IFB_HSISup.bottom ); 406568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_HSISup.top = CNV_LITTLE_TO_SHORT( ifbp->IFB_HSISup.top ); 406668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 406768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.len = sizeof(CFG_SUP_RANGE_STRCT)/sizeof(hcf_16) - 1; 406868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.typ = CFG_FW_SUP_RANGE; 406968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)hcf_get_info( ifbp, (LTVP)&ifbp->IFB_FWSup.len ); 407068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/* ;? conversion should not be needed for mmd_check_comp */ 407168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 407268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.role = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWSup.role ); 407368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.id = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWSup.id ); 407468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.variant = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWSup.variant ); 407568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.bottom = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWSup.bottom ); 407668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_FWSup.top = CNV_LITTLE_TO_SHORT( ifbp->IFB_FWSup.top ); 407768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 407868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4079543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_FWSup.id == COMP_ID_PRI ) { /* 20*/ 4080543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i = sizeof( CFG_FW_IDENTITY_STRCT) + sizeof(CFG_SUP_RANGE_STRCT ); 408168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( i-- ) ((hcf_8*)(&ifbp->IFB_PRIIdentity))[i] = ((hcf_8*)(&ifbp->IFB_FWIdentity))[i]; 408268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_PRIIdentity.typ = CFG_PRI_IDENTITY; 408368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_PRISup.typ = CFG_PRI_SUP_RANGE; 408468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot xxxx[xxxx_PRI_IDENTITY_OFFSET] = &ifbp->IFB_PRIIdentity.len; 408568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot xxxx[xxxx_PRI_IDENTITY_OFFSET+1] = &ifbp->IFB_PRISup.len; 408668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4087543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( !mmd_check_comp( (void*)&cfg_drv_act_ranges_hsi, &ifbp->IFB_HSISup) /* 22*/ 408868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if ( (HCF_TYPE) & HCF_TYPE_PRELOADED ) == 0 408968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//;? the PRI compatibility check is only relevant for DHF 4090543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy || !mmd_check_comp( (void*)&cfg_drv_act_ranges_pri, &ifbp->IFB_PRISup) 409168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_PRELOADED 4092543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) { 409368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CardStat = CARD_STAT_INCOMP_PRI; 409468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_INCOMP_PRI; 409568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4096543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( ifbp->IFB_FWSup.id == COMP_ID_STA && !mmd_check_comp( (void*)&cfg_drv_act_ranges_sta, &ifbp->IFB_FWSup) ) || 4097543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( ifbp->IFB_FWSup.id == COMP_ID_APF && !mmd_check_comp( (void*)&cfg_drv_act_ranges_apf, &ifbp->IFB_FWSup) ) 4098543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) { /* 24 */ 409968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CardStat |= CARD_STAT_INCOMP_FW; 410068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_INCOMP_FW; 410168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 410268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 410368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // MSF_COMPONENT_ID 410449e9563d4e80c42205b87e7ddfbdaf6ea5e6fb06David Kilroy 410568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( rc == HCF_SUCCESS && ifbp->IFB_FWIdentity.comp_id >= COMP_ID_FW_STA ) { 4106543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy PROT_CNT_INI; 410768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot /************************************************************************************** 4108543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * rlav: the DMA engine needs the host to cause a 'hanging alloc event' for it to consume. 4109543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * not sure if this is the right spot in the HCF, thinking about hcf_enable... 4110543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy **************************************************************************************/ 411168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_exe( ifbp, HCMD_ALLOC, 0 ); 411268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 180 degree error in logic ;? #if ALLOC_15 4113543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_RscInd = 1; //let's hope that by the time hcf_send_msg isa called, there will be a FID 411468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//#else 411568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( rc == HCF_SUCCESS ) { 411668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( (IPW( HREG_EV_STAT ) & HREG_EV_ALLOC) == 0 ); 4117788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( HCFASSERT(prot_cnt, IPW( HREG_EV_STAT )) ); 411868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_DMA 411968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ! ( ifbp->IFB_CntlOpt & USE_DMA ) ) 412068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_DMA 412168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 412268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_RscInd = get_fid( ifbp ); 4123788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_RscInd, 0 ); 412468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot cmd_exe( ifbp, HCMD_ALLOC, 0 ); 4125788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_PROT_TIME( if ( prot_cnt == 0 ) rc = HCF_ERR_TIME_OUT ); 412668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 412768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 412868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//#endif // ALLOC_15 412968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 413049e9563d4e80c42205b87e7ddfbdaf6ea5e6fb06David Kilroy 4131788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( rc == HCF_SUCCESS, rc ); 4132788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFLOGEXIT( HCF_TRACE_INIT ); 413368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 413468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // init 413568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 413668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4137543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4138543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void isr_info( IFBP ifbp ) 4139543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE handles link events. 4140543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4141543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4142543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4143543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4144543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 4145543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4146543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4147543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4148543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4149543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4150543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: First the FID number corresponding with the InfoEvent is determined. 4151543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note the complication of the zero-FID protection sub-scheme in DAWA. 4152543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Next the L-field and the T-field are fetched into scratch buffer info. 4153543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: In case of tallies, the 16 bits Hermes values are accumulated in the IFB into 32 bits values. Info[0] 4154543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * is (expected to be) HCF_NIC_TAL_CNT + 1. The contraption "while ( info[0]-- >1 )" rather than 4155543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "while ( --info[0] )" is used because it is dangerous to determine the length of the Value field by 4156543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * decrementing info[0]. As a result of a bug in some version of the F/W, info[0] may be 0, resulting 4157543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * in a very long loop in the pre-decrement logic. 4158543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: In case of a link status frame, the information is copied to the IFB field IFB_linkStat 4159543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: All other than Tallies (including "unknown" ones) are checked against the selection set by the MSF 4160543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * via CFG_RID_LOG. If a match is found or the selection set has the wild-card type (i.e non-NULL buffer 4161543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * pointer at the terminating zero-type), the frame is copied to the (type-specific) log buffer. 4162543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that to accumulate tallies into IFB AND to log them or to log a frame when a specific match occures 4163543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * AND based on the wild-card selection, you have to call setup_bap again after the 1st copy. 4164543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4165543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4166543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4167543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 416868c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 416968c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootisr_info( IFBP ifbp ) 417068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 4171543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 info[2], fid; 417268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_INFO_LOG 4173543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy RID_LOGP ridp = ifbp->IFB_RIDLogp; //NULL or pointer to array of RID_LOG structures (terminated by zero typ) 417468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_INFO_LOG 417568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4176543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFTRACE( ifbp, HCF_TRACE_ISR_INFO ); /* 1 */ 417768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot fid = IPW( HREG_INFO_FID ); 4178788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy DAWA_ZERO_FID( HREG_INFO_FID ); 417968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( fid ) { 418068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot (void)setup_bap( ifbp, fid, 0, IO_IN ); 418168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, (wci_bufp)info, 4 BE_PAR(2) ); 4182788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( info[0] <= HCF_MAX_LTV + 1, MERGE_2( info[1], info[0] ) ); //;? a smaller value makes more sense 4183543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy#if (HCF_TALLIES) & HCF_TALLIES_NIC //Hermes tally support 418468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( info[1] == CFG_TALLIES ) { 4185543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 *p; 4186543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*2*/ if ( info[0] > HCF_NIC_TAL_CNT ) { 418768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot info[0] = HCF_NIC_TAL_CNT + 1; 418868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 418968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p = (hcf_32*)&ifbp->IFB_NIC_Tallies; 4190543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy while ( info[0]-- >1 ) *p++ += IPW( HREG_DATA_1 ); //request may return zero length 419168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 419268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot else 419368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TALLIES_NIC 419468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot { 4195543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*4*/ if ( info[1] == CFG_LINK_STAT ) { 419668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_LinkStat = IPW( HREG_DATA_1 ); 419768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 419868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_EXT) & HCF_EXT_INFO_LOG 4199543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*6*/ while ( 1 ) { 420068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ridp->typ == 0 || ridp->typ == info[1] ) { 420168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ridp->bufp ) { 4202788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ridp->len >= 2, ridp->typ ); 4203543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ridp->bufp[0] = min((hcf_16)(ridp->len - 1), info[0] ); //save L 4204543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ridp->bufp[1] = info[1]; //save T 420568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot get_frag( ifbp, (wci_bufp)&ridp->bufp[2], (ridp->bufp[0] - 1)*2 BE_PAR(0) ); 420668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 420768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot break; 420868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 420968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ridp++; 421068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 421168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_EXT_INFO_LOG 421268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 421368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFTRACE( ifbp, HCF_TRACE_ISR_INFO | HCF_TRACE_EXIT ); 421468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 421568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return; 421668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // isr_info 421768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 421868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 421968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 422068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #endif // HCF_TALLIES_NIC 4221543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// /*4*/ if ( info[1] == CFG_LINK_STAT ) { 4222543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_DSLinkStat = IPW( HREG_DATA_1 ) | CFG_LINK_STAT_CHANGE; //corrupts BAP !! ;? 4223543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_LinkStat = ifbp->IFB_DSLinkStat & CFG_LINK_STAT_FW; //;? to be obsoleted 4224543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// printk( "<4>linkstatus: %04x\n", ifbp->IFB_DSLinkStat ); //;?remove me 1 day 422568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #if (HCF_SLEEP) & HCF_DDS 4226543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// if ( ( ifbp->IFB_DSLinkStat & CFG_LINK_STAT_CONNECTED ) == 0 ) { //even values are disconnected etc. 4227543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ifbp->IFB_TickCnt = 0; //start 2 second period (with 1 tick uncertanty) 4228543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// printk( "<5>isr_info: AwaitConnection phase started, IFB_TickCnt = 0\n" ); //;?remove me 1 day 4229543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 423068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #endif // HCF_DDS 4231543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 423268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #if (HCF_EXT) & HCF_EXT_INFO_LOG 4233543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// /*6*/ while ( 1 ) { 4234543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// if ( ridp->typ == 0 || ridp->typ == info[1] ) { 4235543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// if ( ridp->bufp ) { 4236543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// HCFASSERT( ridp->len >= 2, ridp->typ ); 4237543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// (void)setup_bap( ifbp, fid, 2, IO_IN ); //restore BAP for tallies, linkstat and specific type followed by wild card 4238543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ridp->bufp[0] = min( ridp->len - 1, info[0] ); //save L 4239543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// get_frag( ifbp, (wci_bufp)&ridp->bufp[1], ridp->bufp[0]*2 BE_PAR(0) ); 4240543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 4241543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// break; //;?this break is no longer needed due to setup_bap but lets concentrate on DDS first 4242543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 4243543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// ridp++; 4244543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 424568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// #endif // HCF_EXT_INFO_LOG 4246543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// } 4247543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// HCFTRACE( ifbp, HCF_TRACE_ISR_INFO | HCF_TRACE_EXIT ); 424868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 424968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 425068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 425168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot// 4252543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy// return; 425368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot//} // isr_info 425468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 425568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 425668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4257543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4258543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void mdd_assert( IFBP ifbp, unsigned int line_number, hcf_32 q ) 4259543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE filters assert on level and interfaces to the MSF supplied msf_assert routine. 4260543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4261543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4262543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4263543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * line_number line number of the line which caused the assert 4264543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * q qualifier, additional information which may give a clue about the problem 4265543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4266543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 4267543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4268543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4269543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4270543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4271543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4272543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4273543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 4274543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * mdd_assert has been through a turmoil, renaming hcf_assert to assert and hcf_assert again and supporting off 4275543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and on being called from the MSF level and other ( immature ) ModularDriverDevelopment modules like DHF and 4276543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * MMD. 427768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * !!!! The assert routine is not an hcf_..... routine in the sense that it may be called by the MSF, 4278543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * however it is called from mmd.c and dhf.c, so it must be external. 4279543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * To prevent namespace pollution it needs a prefix, to prevent that MSF programmers think that 4280543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * they are allowed to call the assert logic, the prefix HCF can't be used, so MDD is selected!!!! 428168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot * 4282543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * When called from the DHF module the line number is incremented by DHF_FILE_NAME_OFFSET and when called from 4283543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the MMD module by MMD_FILE_NAME_OFFSET. 4284543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4285543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4286543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4287543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 428868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT 428968c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootvoid 429068c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootmdd_assert( IFBP ifbp, unsigned int line_number, hcf_32 q ) 429168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 4292543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 run_time_flag = ifbp->IFB_AssertLvl; 429368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 429468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( run_time_flag /* > ;?????? */ ) { //prevent recursive behavior, later to be extended to level filtering 429568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertQualifier = q; 429668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertLine = (hcf_16)line_number; 429768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & ( HCF_ASSERT_LNK_MSF_RTN | HCF_ASSERT_RT_MSF_RTN ) 429868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_AssertRtn ) { 429968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_AssertRtn( line_number, ifbp->IFB_AssertTrace, q ); 430068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 430168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_LNK_MSF_RTN / HCF_ASSERT_RT_MSF_RTN 430268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_ASSERT) & HCF_ASSERT_SW_SUP 430368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_SW_2, line_number ); 430468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_SW_2, ifbp->IFB_AssertTrace ); 430568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_SW_2, (hcf_16)q ); 430668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_SW_2, (hcf_16)(q >> 16 ) ); 430768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT_SW_SUP 430868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 43097c22429923c393853687266cd9d99c13c688f0a1David Kilroy#if (HCF_ASSERT) & HCF_ASSERT_MB 4310543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_AssertLvl = 0; // prevent recursive behavior 431168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot hcf_put_info( ifbp, (LTVP)&ifbp->IFB_AssertStrct ); 4312543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_AssertLvl = run_time_flag; // restore appropriate filter level 43137c22429923c393853687266cd9d99c13c688f0a1David Kilroy#endif // HCF_ASSERT_MB 431468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 431568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // mdd_assert 431668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 431768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 431868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 431968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4320543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4321543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void put_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ) 4322543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE writes with 16/32 bit I/O via BAP1 port from Host memory to NIC RAM. 4323543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4324543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4325543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4326543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bufp (byte) address of buffer 4327543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len length in bytes of buffer specified by bufp 4328543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * word_len Big Endian only: number of leading bytes to swap in pairs 4329543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4330543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 4331543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4332543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4333543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * process the single byte (if applicable) not yet written by the previous put_frag and copy len 4334543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * (or len-1) bytes from bufp to NIC. 4335543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4336543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4337543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4338543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4339543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 4340543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * It turns out DOS ODI uses zero length fragments. The HCF code can cope with it, but as a consequence, no 4341543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Assert on len is possible 4342543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4343543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4344543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4345543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 434668c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 434768c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootput_frag( IFBP ifbp, wci_bufp bufp, int len BE_PAR( int word_len ) ) 434868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 4349543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_io io_port = ifbp->IFB_IOBase + HREG_DATA_1; //BAP data register 4350543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int i; //prevent side effects from macro 4351543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 j; 4352788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ((hcf_32)bufp & (HCF_ALIGN-1) ) == 0, (hcf_32)bufp ); 435368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_BIG_ENDIAN 4354788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len == 0 || word_len == 2 || word_len == 4, word_len ); 4355788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len == 0 || ((hcf_32)bufp & 1 ) == 0, (hcf_32)bufp ); 4356788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( word_len <= len, MERGE_2( word_len, len ) ); 435768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4358543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( word_len ) { //if there is anything to convert 4359543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. convert and write the 1st hcf_16 436068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = bufp[1] | bufp[0]<<8; 436168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_WORD( io_port, j ); 4362543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. update pointer and counter accordingly 436368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 2; 436468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp += 2; 4365543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( word_len > 1 ) { //. if there is to convert more than 1 word ( i.e 2 ) 4366543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . convert and write the 2nd hcf_16 4367543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy j = bufp[1] | bufp[0]<<8; /*bufp is already incremented by 2*/ 436868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_WORD( io_port, j ); 4369543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . update pointer and counter accordingly 437068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len -= 2; 437168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp += 2; 437268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 437368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 437468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_BIG_ENDIAN 437568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i = len; 4376543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( i && ifbp->IFB_CarryOut ) { //skip zero-length 437768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = ((*bufp)<<8) + ( ifbp->IFB_CarryOut & 0xFF ); 437868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_WORD( io_port, j ); 437968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp++; i--; 438068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CarryOut = 0; 438168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 438268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_IO) & HCF_IO_32BITS 438368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //skip zero-length I/O, single byte I/O and I/O not worthwhile (i.e. less than 6 bytes)for DW logic 4384543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if buffer length >= 6 and 32 bits I/O support 438568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( !(ifbp->IFB_CntlOpt & USE_16BIT) && i >= 6 ) { 4386543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_32 FAR *p4; //prevent side effects from macro 4387543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( (hcf_32)bufp & 0x1 ) == 0 ) { //. if buffer at least word aligned 4388543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( (hcf_32)bufp & 0x2 ) { //. . if buffer not double word aligned 4389543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . write a single word to get double word aligned 4390543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy j = *(wci_recordp)bufp; //just to help ease writing macros with embedded assembly 439168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_WORD( io_port, j ); 4392543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . . adjust buffer length and pointer accordingly 439368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp += 2; i -= 2; 439468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4395543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . write as many double word as possible 439668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot p4 = (hcf_32 FAR *)bufp; 439768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = (hcf_16)i/4; 439868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_STRING_32( io_port, p4, j ); 4399543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . adjust buffer length and pointer accordingly 440068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot bufp += i & ~0x0003; 440168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot i &= 0x0003; 440268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 440368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 440468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_IO_32BITS 4405543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //if no 32-bit support OR byte aligned OR 1 word left 440668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i ) { 4407543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. if odd number of bytes left 440868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( i & 0x0001 ) { 4409543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. . save left over byte (before bufp is corrupted) in carry, set carry flag 4410543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_CarryOut = (hcf_16)bufp[i-1] | 0x0100; //note that i and bufp are always simultaneously modified, &bufp[i-1] is invariant 441168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4412543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. write as many word as possible in "alignment safe" way 441368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot j = (hcf_16)i/2; 441468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OUT_PORT_STRING_8_16( io_port, bufp, j ); 441568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 441668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // put_frag 441768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 441868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 441968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4420543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4421543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE void put_frag_finalize( IFBP ifbp ) 4422543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE cleanup after put_frag for trailing odd byte and MIC transfer to NIC. 4423543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4424543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4425543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4426543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4427543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS N.A. 4428543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4429543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4430543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * finalize the MIC calculation with the padding pattern, output the last byte (if applicable) 4431543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * of the message and the MIC to the TxFS 4432543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4433543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4434543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4435543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: 1 byte of the last put_frag may be still in IFB_CarryOut ( the put_frag carry holder ), so ........ 4436543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 1 - 3 bytes of the last put_frag may be still in IFB_tx_32 ( the MIC engine carry holder ), so ........ 4437543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The call to the MIC calculation routine feeds these remaining bytes (if any) of put_frag and the 4438543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * just as many bytes of the padding as needed to the MIC calculation engine. Note that the "unneeded" pad 4439543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * bytes simply end up in the MIC engine carry holder and are never used. 4440543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: write the remainder of the MIC and possible some garbage to NIC RAM 4441543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note: i is always 4 (a loop-invariant of the while in point 2) 4442543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4443543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 4444543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4445543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4446543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4447543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 444868c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC void 444968c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootput_frag_finalize( IFBP ifbp ) 445068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 445168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if (HCF_TYPE) & HCF_TYPE_WPA 4452543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_MICTxCarry != 0xFFFF) { //if MIC calculation active 4453543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy CALC_TX_MIC( mic_pad, 8); //. feed (up to 8 bytes of) virtual padding to MIC engine 4454543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy //. write (possibly) trailing byte + (most of) MIC 445568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frag( ifbp, (wci_bufp)ifbp->IFB_MICTx, 8 BE_PAR(0) ); 445668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 445768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_TYPE_WPA 4458543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy put_frag( ifbp, null_addr, 1 BE_PAR(0) ); //write (possibly) trailing data or MIC byte 445968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // put_frag_finalize 446068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 446168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 446268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4463543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4464543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int put_info( IFBP ifbp, LTVP ltvp ) 4465543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE support routine to handle the "basic" task of hcf_put_info to pass RIDs to the NIC. 4466543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4467543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4468543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4469543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ltvp address in NIC RAM where LVT-records are located 4470543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4471543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 4472543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS 4473543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * >>put_frag 4474543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * >>cmd_wait 4475543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4476543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4477543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4478543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4479543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4480543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *20: do not write RIDs to NICs which have incompatible Firmware 4481543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *24: If the RID does not exist, the L-field is set to zero. 4482543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that some RIDs can not be read, e.g. the pseudo RIDs for direct Hermes commands and CFG_DEFAULT_KEYS 4483543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *28: If the RID is written successful, pass it to the NIC by means of an Access Write command 4484543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4485543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 4486543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The mechanism to HCF_ASSERT on invalid typ-codes in the LTV record is based on the following strategy: 4487543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - some codes (e.g. CFG_REG_MB) are explicitly handled by the HCF which implies that these codes 4488543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * are valid. These codes are already consumed by hcf_put_info. 4489543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - all other codes are passed to the Hermes. Before the put action is executed, hcf_get_info is called 4490543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * with an LTV record with a value of 1 in the L-field and the intended put action type in the Typ-code 4491543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * field. If the put action type is valid, it is also valid as a get action type code - except 4492543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * for CFG_DEFAULT_KEYS and CFG_ADD_TKIP_DEFAULT_KEY - so the HCF_ASSERT logic of hcf_get_info should 4493543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * not catch. 4494543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4495543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4496543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4497543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 449868c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 4499543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroyput_info( IFBP ifbp, LTVP ltvp ) 450068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 450168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4502543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 450368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4504788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_CardStat == 0, MERGE_2( ltvp->typ, ifbp->IFB_CardStat ) ); 4505788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( CFG_RID_CFG_MIN <= ltvp->typ && ltvp->typ <= CFG_RID_CFG_MAX, ltvp->typ ); 450668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4507543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ifbp->IFB_CardStat == 0 && /* 20*/ 4508543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( ( CFG_RID_CFG_MIN <= ltvp->typ && ltvp->typ <= CFG_RID_CFG_MAX ) || 4509543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( CFG_RID_ENG_MIN <= ltvp->typ /* && ltvp->typ <= 0xFFFF */ ) ) ) { 451068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#if HCF_ASSERT //FCC8, FCB0, FCB4, FCB6, FCB7, FCB8, FCC0, FCC4, FCBC, FCBD, FCBE, FCBF 4511543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy { 4512543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 t = ltvp->typ; 4513543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy LTV_STRCT x = { 2, t, {0} }; /*24*/ 4514543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_get_info( ifbp, (LTVP)&x ); 4515543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( x.len == 0 && 4516543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ( t != CFG_DEFAULT_KEYS && t != CFG_ADD_TKIP_DEFAULT_KEY && t != CFG_REMOVE_TKIP_DEFAULT_KEY && 4517543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy t != CFG_ADD_TKIP_MAPPED_KEY && t != CFG_REMOVE_TKIP_MAPPED_KEY && 4518543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy t != CFG_HANDOVER_ADDR && t != CFG_DISASSOCIATE_ADDR && 4519543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy t != CFG_FCBC && t != CFG_FCBD && t != CFG_FCBE && t != CFG_FCBF && 4520543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy t != CFG_DEAUTHENTICATE_ADDR 4521543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) 4522543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ) { 4523543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( DO_ASSERT, ltvp->typ ); 4524543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy } 452568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 452668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot#endif // HCF_ASSERT 452768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 452868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = setup_bap( ifbp, ltvp->typ, 0, IO_OUT ); 452968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot put_frag( ifbp, (wci_bufp)ltvp, 2*ltvp->len + 2 BE_PAR(2) ); 4530543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy /*28*/ if ( rc == HCF_SUCCESS ) { 453168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = cmd_exe( ifbp, HCMD_ACCESS + HCMD_ACCESS_WRITE, ltvp->typ ); 453268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 453368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 453468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 453568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // put_info 453668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 453768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 453868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4539543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4540543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int put_info_mb( IFBP ifbp, CFG_MB_INFO_STRCT FAR * ltvp ) 4541543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE accumulates a ( series of) buffers into a single Info block into the MailBox. 4542543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4543543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4544543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of the Interface Block 4545543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ltvp address of structure specifying the "type" and the fragments of the information to be synthesized 4546543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * as an LTV into the MailBox 4547543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4548543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 4549543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4550543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4551543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the data does not fit (including no MailBox is available), the IFB_MBTally is incremented and an 4552543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * error status is returned. 4553543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ASSERT does not catch. 4554543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Calling put_info_mb when their is no MailBox available, is considered a design error in the MSF. 4555543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4556543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that there is always at least 1 word of unused space in the mail box. 4557543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * As a consequence: 4558543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - no problem in pointer arithmetic (MB_RP == MB_WP means unambiguously mail box is completely empty 4559543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - There is always free space to write an L field with a value of zero after each MB_Info block. This 4560543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * allows for an easy scan mechanism in the "get MB_Info block" logic. 4561543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4562543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4563543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4564543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *1: Calculate L field of the MBIB, i.e. 1 for the T-field + the cumulative length of the fragments. 4565543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: The free space in the MailBox is calculated (2a: free part from Write Ptr to Read Ptr, 2b: free part 4566543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * turns out to wrap around) . If this space suffices to store the number of words reflected by len (T-field 4567543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * + Value-field) plus the additional MailBox Info L-field + a trailing 0 to act as the L-field of a trailing 4568543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * dummy or empty LTV record, then a MailBox Info block is build in the MailBox consisting of 4569543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the value len in the first word 4570543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - type in the second word 4571543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - a copy of the contents of the fragments in the second and higher word 4572543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4573543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: Since put_info_mb() can more or less directly be called from the MSF level, the I/F must be robust 4574543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * against out-of-range variables. As failsafe coding, the MB update is skipped by changing tlen to 0 if 4575543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * len == 0; This will indirectly cause an assert as result of the violation of the next if clause. 4576543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: Check whether the free space in MailBox suffices (this covers the complete absence of the MailBox). 4577543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Note that len is unsigned, so even MSF I/F violation works out O.K. 4578543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The '2' in the expression "len+2" is used because 1 word is needed for L itself and 1 word is needed 4579543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * for the zero-sentinel 4580543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: update MailBox Info length report to MSF with "oldest" MB Info Block size. Be careful here, if you get 4581543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * here before the MailBox is registered, you can't read from the buffer addressed by IFB_MBp (it is the 4582543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Null buffer) so don't move this code till the end of this routine but keep it where there is garuanteed 4583543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a buffer. 4584543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4585543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.NOTICE 4586543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * boundary testing depends on the fact that IFB_MBSize is guaranteed to be zero if no MailBox is present, 4587543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * and to a lesser degree, that IFB_MBWp = IFB_MBRp = 0 4588543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4589543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4590543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4591543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 459268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 459368c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 459468c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootput_info_mb( IFBP ifbp, CFG_MB_INFO_STRCT FAR * ltvp ) 459568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 459668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4597543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc = HCF_SUCCESS; 4598543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 i; //work counter 4599543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 *dp; //destination pointer (in MailBox) 4600543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy wci_recordp sp; //source pointer 4601543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 len; //total length to copy to MailBox 4602543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy hcf_16 tlen; //free length/working length/offset in WMP frame 460368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 460468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBp == NULL ) return rc; //;?not sufficient 4605543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( ifbp->IFB_MBp != NULL, 0 ); //!!!be careful, don't get into an endless recursion 4606788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( ifbp->IFB_MBSize, 0 ); 460768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4608543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy len = 1; /* 1 */ 460968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot for ( i = 0; i < ltvp->frag_cnt; i++ ) { 461068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len += ltvp->frag_buf[i].frag_len; 461168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 461268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBRp > ifbp->IFB_MBWp ) { 4613543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy tlen = ifbp->IFB_MBRp - ifbp->IFB_MBWp; /* 2a*/ 461468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 461568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( ifbp->IFB_MBRp == ifbp->IFB_MBWp ) { 4616543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBRp = ifbp->IFB_MBWp = 0; // optimize Wrapping 461768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4618543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy tlen = ifbp->IFB_MBSize - ifbp->IFB_MBWp; /* 2b*/ 4619543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( ( tlen <= len + 2 ) && ( len + 2 < ifbp->IFB_MBRp ) ) { //if trailing space is too small but 4620543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy // leading space is sufficiently large 4621543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBp[ifbp->IFB_MBWp] = 0xFFFF; //flag dummy LTV to fill the trailing space 4622543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBWp = 0; //reset WritePointer to begin of MailBox 4623543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy tlen = ifbp->IFB_MBRp; //get new available space size 462468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 462568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 462668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot dp = &ifbp->IFB_MBp[ifbp->IFB_MBWp]; 462768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( len == 0 ) { 462868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot tlen = 0; //;? what is this good for 462968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4630543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if ( len + 2 >= tlen ){ /* 6 */ 463168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot //Do Not ASSERT, this is a normal condition 4632788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy IF_TALLY( ifbp->IFB_HCF_Tallies.NoBufMB++ ); 463368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = HCF_ERR_LEN; 463468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } else { 4635543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *dp++ = len; //write Len (= size of T+V in words to MB_Info block 4636543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *dp++ = ltvp->base_typ; //write Type to MB_Info block 4637543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBWp += len + 1; //update WritePointer of MailBox 4638543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy for ( i = 0; i < ltvp->frag_cnt; i++ ) { // process each of the fragments 463968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot sp = ltvp->frag_buf[i].frag_addr; 464068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot len = ltvp->frag_buf[i].frag_len; 464168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot while ( len-- ) *dp++ = *sp++; 464268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 4643543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBp[ifbp->IFB_MBWp] = 0; //to assure get_info for CFG_MB_INFO stops 4644543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ifbp->IFB_MBInfoLen = ifbp->IFB_MBp[ifbp->IFB_MBRp]; /* 8 */ 464568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 464668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 464768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // put_info_mb 464868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 464968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 465068c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot/************************************************************************************************************ 4651543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4652543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.SUBMODULE int setup_bap( IFBP ifbp, hcf_16 fid, int offset, int type ) 4653543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.PURPOSE set up data access to NIC RAM via BAP_1. 4654543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4655543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ARGUMENTS 4656543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * ifbp address of I/F Block 4657543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * fid FID/RID 4658543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * offset !!even!! offset in FID/RID 4659543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * type IO_IN, IO_OUT 4660543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4661543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.RETURNS 4662543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_SUCCESS O.K 4663543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_NO_NIC card is removed 4664543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_TIME_OUT Fatal malfunction detected 4665543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * HCF_ERR_DEFUNCT_..... if and only if IFB_DefunctStat <> 0 4666543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4667543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DESCRIPTION 4668543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4669543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * A non-zero return status indicates: 4670543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the NIC is considered nonoperational, e.g. due to a time-out of some Hermes activity in the past 4671543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - BAP_1 could not properly be initialized 4672543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * - the card is removed before completion of the data transfer 4673543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * In all other cases, a zero is returned. 4674543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * BAP Initialization failure indicates an H/W error which is very likely to signal complete H/W failure. 4675543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Once a BAP Initialization failure has occurred all subsequent interactions with the Hermes will return a 4676543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * "defunct" status till the Hermes is re-initialized by means of an hcf_connect. 4677543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4678543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * A BAP is a set of registers (Offset, Select and Data) offering read/write access to a particular FID or 4679543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * RID. This access is based on a auto-increment feature. 4680543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * There are two BAPs but these days the HCF uses only BAP_1 and leaves BAP_0 to the PCI Busmastering H/W. 4681543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4682543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The BAP-mechanism is based on the Busy bit in the Offset register (see the Hermes definition). The waiting 4683543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * for Busy must occur between writing the Offset register and accessing the Data register. The 4684543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * implementation to wait for the Busy bit drop after each write to the Offset register, implies that the 4685543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * requirement that the Busy bit is low before the Select register is written, is automatically met. 4686543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * BAP-setup may be time consuming (e.g. 380 usec for large offsets occurs frequently). The wait for Busy bit 4687543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * drop is protected by a loop counter, which is initialized with IFB_TickIni, which is calibrated in init. 4688543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4689543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * The NIC I/F is optimized for word transfer and can only handle word transfer at a word boundary in NIC 4690543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * RAM. The intended solution for transfer of a single byte has multiple H/W flaws. There have been different 4691543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * S/W Workaround strategies. RID access is hcf_16 based by "nature", so no byte access problems. For Tx/Rx 4692543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * FID access, the byte logic became obsolete by absorbing it in the double word oriented nature of the MIC 4693543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * feature. 4694543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4695543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4696543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.DIAGRAM 4697543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4698543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *2: the test on rc checks whether the HCF went into "defunct" mode ( e.g. BAP initialization or a call to 4699543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * cmd_wait did ever fail). 4700543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *4: the select register and offset register are set 4701543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * the offset register is monitored till a successful condition (no busy bit) is detected or till the 4702543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * (calibrated) protection counter expires 4703543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * If the counter expires, this is reflected in IFB_DefunctStat, so all subsequent calls to setup_bap fail 4704543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * immediately ( see 2) 4705543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *6: initialization of the carry as used by pet/get_frag 4706543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *8: HREG_OFFSET_ERR is ignored as error because: 4707543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * a: the Hermes is robust against it 4708543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * b: it is not known what causes it (probably a bug), hence no strategy can be specified which level is 4709543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * to handle this error in which way. In the past, it could be induced by the MSF level, e.g. by calling 4710543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * hcf_rcv_msg while there was no Rx-FID available. Since this is an MSF-error which is caught by ASSERT, 4711543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * there is no run-time action required by the HCF. 4712543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * Lumping the Offset error in with the Busy bit error, as has been done in the past turns out to be a 4713543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * disaster or a life saver, just depending on what the cause of the error is. Since no prediction can be 4714543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * done about the future, it is "felt" to be the best strategy to ignore this error. One day the code was 4715543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * accompanied by the following comment: 4716543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * // ignore HREG_OFFSET_ERR, someone, supposedly the MSF programmer ;) made a bug. Since we don't know 4717543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * // what is going on, we might as well go on - under management pressure - by ignoring it 4718543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4719543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy *.ENDDOC END DOCUMENTATION 4720543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy * 4721543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy ************************************************************************************************************/ 472268c0bdff7ac903421f224e080499c51cd5287f97Henk de GrootHCF_STATIC int 472368c0bdff7ac903421f224e080499c51cd5287f97Henk de Grootsetup_bap( IFBP ifbp, hcf_16 fid, int offset, int type ) 472468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot{ 4725543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy PROT_CNT_INI; 4726543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy int rc; 472768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 472868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFTRACE( ifbp, HCF_TRACE_STRIO ); 4729491dbc8d1ae56199ad199830d16c77c8317aa987Joe Perches rc = ifbp->IFB_DefunctStat; 4730543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy if (rc == HCF_SUCCESS) { /*2*/ 4731543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy OPW( HREG_SELECT_1, fid ); /*4*/ 473268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot OPW( HREG_OFFSET_1, offset ); 473368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( type == IO_IN ) { 473468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CarryIn = 0; 473568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 473668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot else ifbp->IFB_CarryOut = 0; 473768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCF_WAIT_WHILE( IPW( HREG_OFFSET_1) & HCMD_BUSY ); 4738543fd0a349dbb2f6ab896ec97cedbbd6fe4d1ee6David Kilroy HCFASSERT( !( IPW( HREG_OFFSET_1) & HREG_OFFSET_ERR ), MERGE_2( fid, offset ) ); /*8*/ 473968c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot if ( prot_cnt == 0 ) { 4740788c2bce7e06f9fd682a7a2db9d6b823e1d18d44David Kilroy HCFASSERT( DO_ASSERT, MERGE_2( fid, offset ) ); 474168c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot rc = ifbp->IFB_DefunctStat = HCF_ERR_DEFUNCT_TIME_OUT; 474268c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot ifbp->IFB_CardStat |= CARD_STAT_DEFUNCT; 474368c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 474468c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot } 474568c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot HCFTRACE( ifbp, HCF_TRACE_STRIO | HCF_TRACE_EXIT ); 474668c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot return rc; 474768c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot} // setup_bap 474868c0bdff7ac903421f224e080499c51cd5287f97Henk de Groot 4749