/*
 * Driver O/S-independent utility routines
 *
 * Copyright 2007, Broadcom Corporation
 * All Rights Reserved.
 * 
 * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
 * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
 * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
 * $Id$
 */

#include <typedefs.h>
#include <bcmdefs.h>
#include <stdarg.h>
#include "bcmutils.h"
#include <osl.h>
#include <sbutils.h>
#include <bcmnvram.h>
#include <bcmendian.h>
#include <bcmdevs.h>
#include "proto/ethernet.h"
#include "proto/vlan.h"
#include "proto/bcmip.h"
#include "proto/bcmtcp.h"
#include "proto/802.1d.h"

#ifdef BCMPERFSTATS
#include <bcmperf.h>
#endif

#if 0
/* nvram vars cache */
static char *nvram_vars = NULL;
static int vars_len = -1;
#endif

/* copy a pkt buffer chain into a buffer */
uint
pktcopy (osl_t * osh, void *p, uint offset, int len, uchar * buf)
{
  uint n, ret = 0;

  if (len < 0)
    len = 4096;			/* "infinite" */

  /* skip 'offset' bytes */
  for (; p && offset; p = PKTNEXT (osh, p))
    {
      if (offset < (uint) PKTLEN (osh, p))
	break;
      offset -= PKTLEN (osh, p);
    }

  if (!p)
    return 0;

  /* copy the data */
  for (; p && len; p = PKTNEXT (osh, p))
    {
      n = MIN ((uint) PKTLEN (osh, p) - offset, (uint) len);
      bcopy (PKTDATA (osh, p) + offset, buf, n);
      buf += n;
      len -= n;
      ret += n;
      offset = 0;
    }

  return ret;
}

/* return total length of buffer chain */
uint
pkttotlen (osl_t * osh, void *p)
{
  uint total;

  total = 0;
  for (; p; p = PKTNEXT (osh, p))
    total += PKTLEN (osh, p);
  return (total);
}

/* return the last buffer of chained pkt */
void *
pktlast (osl_t * osh, void *p)
{
  for (; PKTNEXT (osh, p); p = PKTNEXT (osh, p))
    ;

  return (p);
}


/*
 * osl multiple-precedence packet queue
 * hi_prec is always >= the number of the highest non-empty precedence
 */
void *
pktq_penq (struct pktq *pq, int prec, void *p)
{
  struct pktq_prec *q;

  ASSERT (prec >= 0 && prec < pq->num_prec);
  ASSERT (PKTLINK (p) == NULL);	/* queueing chains not allowed */

  ASSERT (!pktq_full (pq));
  ASSERT (!pktq_pfull (pq, prec));

  q = &pq->q[prec];

  if (q->head)
    PKTSETLINK (q->tail, p);
  else
    q->head = p;

  q->tail = p;
  q->len++;

  pq->len++;

  if (pq->hi_prec < prec)
    pq->hi_prec = (uint8) prec;

  return p;
}

void *
pktq_penq_head (struct pktq *pq, int prec, void *p)
{
  struct pktq_prec *q;

  ASSERT (prec >= 0 && prec < pq->num_prec);
  ASSERT (PKTLINK (p) == NULL);	/* queueing chains not allowed */

  ASSERT (!pktq_full (pq));
  ASSERT (!pktq_pfull (pq, prec));

  q = &pq->q[prec];

  if (q->head == NULL)
    q->tail = p;

  PKTSETLINK (p, q->head);
  q->head = p;
  q->len++;

  pq->len++;

  if (pq->hi_prec < prec)
    pq->hi_prec = (uint8) prec;

  return p;
}

void *
pktq_pdeq (struct pktq *pq, int prec)
{
  struct pktq_prec *q;
  void *p;

  ASSERT (prec >= 0 && prec < pq->num_prec);

  q = &pq->q[prec];

  if ((p = q->head) == NULL)
    return NULL;

  if ((q->head = PKTLINK (p)) == NULL)
    q->tail = NULL;

  q->len--;

  pq->len--;

  PKTSETLINK (p, NULL);

  return p;
}

void *
pktq_pdeq_tail (struct pktq *pq, int prec)
{
  struct pktq_prec *q;
  void *p, *prev;

  ASSERT (prec >= 0 && prec < pq->num_prec);

  q = &pq->q[prec];

  if ((p = q->head) == NULL)
    return NULL;

  for (prev = NULL; p != q->tail; p = PKTLINK (p))
    prev = p;

  if (prev)
    PKTSETLINK (prev, NULL);
  else
    q->head = NULL;

  q->tail = prev;
  q->len--;

  pq->len--;

  return p;
}

void
pktq_pflush (osl_t * osh, struct pktq *pq, int prec, bool dir)
{
  struct pktq_prec *q;
  void *p;

  q = &pq->q[prec];
  p = q->head;
  while (p)
    {
      q->head = PKTLINK (p);
      PKTSETLINK (p, NULL);
      PKTFREE (osh, p, dir);
      q->len--;
      pq->len--;
      p = q->head;
    }
  ASSERT (q->len == 0);
  q->tail = NULL;
}

#if 0
bool
pktq_pdel (struct pktq *pq, void *pktbuf, int prec)
{
  struct pktq_prec *q;
  void *p;

  ASSERT (prec >= 0 && prec < pq->num_prec);

  if (!pktbuf)
    return FALSE;

  q = &pq->q[prec];

  if (q->head == pktbuf)
    {
      if ((q->head = PKTLINK (pktbuf)) == NULL)
	q->tail = NULL;
    }
  else
    {
      for (p = q->head; p && PKTLINK (p) != pktbuf; p = PKTLINK (p))
	;
      if (p == NULL)
	return FALSE;

      PKTSETLINK (p, PKTLINK (pktbuf));
      if (q->tail == pktbuf)
	q->tail = p;
    }

  q->len--;
  pq->len--;
  PKTSETLINK (pktbuf, NULL);
  return TRUE;
}
#endif

void
pktq_init (struct pktq *pq, int num_prec, int max_len)
{
  int prec;

  ASSERT (num_prec > 0 && num_prec <= PKTQ_MAX_PREC);

  /* pq is variable size; only zero out what's requested */
  bzero (pq,
	 OFFSETOF (struct pktq, q) + (sizeof (struct pktq_prec) * num_prec));

  pq->num_prec = (uint16) num_prec;

  pq->max = (uint16) max_len;

  for (prec = 0; prec < num_prec; prec++)
    pq->q[prec].max = pq->max;
}

int
pktq_setmax (struct pktq *pq, int max_len)
{
  int prec;

  if (!max_len)
    return pq->max;

  pq->max = (uint16) max_len;
  for (prec = 0; prec < pq->num_prec; prec++)
    pq->q[prec].max = pq->max;

  return pq->max;
}

void *
pktq_deq (struct pktq *pq, int *prec_out)
{
  struct pktq_prec *q;
  void *p;
  int prec;

  if (pq->len == 0)
    return NULL;

  while ((prec = pq->hi_prec) > 0 && pq->q[prec].head == NULL)
    pq->hi_prec--;

  q = &pq->q[prec];

  if ((p = q->head) == NULL)
    return NULL;

  if ((q->head = PKTLINK (p)) == NULL)
    q->tail = NULL;

  q->len--;

  pq->len--;

  if (prec_out)
    *prec_out = prec;

  PKTSETLINK (p, NULL);

  return p;
}

void *
pktq_deq_tail (struct pktq *pq, int *prec_out)
{
  struct pktq_prec *q;
  void *p, *prev;
  int prec;

  if (pq->len == 0)
    return NULL;

  for (prec = 0; prec < pq->hi_prec; prec++)
    if (pq->q[prec].head)
      break;

  q = &pq->q[prec];

  if ((p = q->head) == NULL)
    return NULL;

  for (prev = NULL; p != q->tail; p = PKTLINK (p))
    prev = p;

  if (prev)
    PKTSETLINK (prev, NULL);
  else
    q->head = NULL;

  q->tail = prev;
  q->len--;

  pq->len--;

  if (prec_out)
    *prec_out = prec;

  PKTSETLINK (p, NULL);

  return p;
}

#if 0
void *
pktq_peek (struct pktq *pq, int *prec_out)
{
  int prec;

  if (pq->len == 0)
    return NULL;

  while ((prec = pq->hi_prec) > 0 && pq->q[prec].head == NULL)
    pq->hi_prec--;

  if (prec_out)
    *prec_out = prec;

  return (pq->q[prec].head);
}
#endif

void *
pktq_peek_tail (struct pktq *pq, int *prec_out)
{
  int prec;

  if (pq->len == 0)
    return NULL;

  for (prec = 0; prec < pq->hi_prec; prec++)
    if (pq->q[prec].head)
      break;

  if (prec_out)
    *prec_out = prec;

  return (pq->q[prec].tail);
}

void
pktq_flush (osl_t * osh, struct pktq *pq, bool dir)
{
  int prec;
  for (prec = 0; prec < pq->num_prec; prec++)
    pktq_pflush (osh, pq, prec, dir);
  ASSERT (pq->len == 0);
}

/* Return sum of lengths of a specific set of precedences */
int
pktq_mlen (struct pktq *pq, uint prec_bmp)
{
  int prec, len;

  len = 0;

  for (prec = 0; prec <= pq->hi_prec; prec++)
    if (prec_bmp & (1 << prec))
      len += pq->q[prec].len;

  return len;
}

/* Priority dequeue from a specific set of precedences */
void *
pktq_mdeq (struct pktq *pq, uint prec_bmp, int *prec_out)
{
  struct pktq_prec *q;
  void *p;
  int prec;

  if (pq->len == 0)
    return NULL;

  while ((prec = pq->hi_prec) > 0 && pq->q[prec].head == NULL)
    pq->hi_prec--;

  while ((prec_bmp & (1 << prec)) == 0 || pq->q[prec].head == NULL)
    if (prec-- == 0)
      return NULL;

  q = &pq->q[prec];

  if ((p = q->head) == NULL)
    return NULL;

  if ((q->head = PKTLINK (p)) == NULL)
    q->tail = NULL;

  q->len--;

  if (prec_out)
    *prec_out = prec;

  pq->len--;

  PKTSETLINK (p, NULL);

  return p;
}

const unsigned char bcm_ctype[] = {
  _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C,	/* 0-7 */
  _BCM_C, _BCM_C | _BCM_S, _BCM_C | _BCM_S, _BCM_C | _BCM_S, _BCM_C | _BCM_S,
    _BCM_C | _BCM_S, _BCM_C,
  _BCM_C,			/* 8-15 */
  _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C,	/* 16-23 */
  _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C, _BCM_C,	/* 24-31 */
  _BCM_S | _BCM_SP, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 32-39 */
  _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 40-47 */
  _BCM_D, _BCM_D, _BCM_D, _BCM_D, _BCM_D, _BCM_D, _BCM_D, _BCM_D,	/* 48-55 */
  _BCM_D, _BCM_D, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 56-63 */
  _BCM_P, _BCM_U | _BCM_X, _BCM_U | _BCM_X, _BCM_U | _BCM_X, _BCM_U | _BCM_X,
    _BCM_U | _BCM_X,
  _BCM_U | _BCM_X, _BCM_U,	/* 64-71 */
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U,	/* 72-79 */
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U,	/* 80-87 */
  _BCM_U, _BCM_U, _BCM_U, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 88-95 */
  _BCM_P, _BCM_L | _BCM_X, _BCM_L | _BCM_X, _BCM_L | _BCM_X, _BCM_L | _BCM_X,
    _BCM_L | _BCM_X,
  _BCM_L | _BCM_X, _BCM_L,	/* 96-103 */
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L,	/* 104-111 */
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L,	/* 112-119 */
  _BCM_L, _BCM_L, _BCM_L, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_C,	/* 120-127 */
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* 128-143 */
  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,	/* 144-159 */
  _BCM_S | _BCM_SP, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,
    _BCM_P, _BCM_P,
  _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 160-175 */
  _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,
    _BCM_P, _BCM_P,
  _BCM_P, _BCM_P, _BCM_P, _BCM_P, _BCM_P,	/* 176-191 */
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U,
    _BCM_U, _BCM_U,
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U,	/* 192-207 */
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_P, _BCM_U,
    _BCM_U, _BCM_U,
  _BCM_U, _BCM_U, _BCM_U, _BCM_U, _BCM_L,	/* 208-223 */
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L,
    _BCM_L, _BCM_L,
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L,	/* 224-239 */
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_P, _BCM_L,
    _BCM_L, _BCM_L,
  _BCM_L, _BCM_L, _BCM_L, _BCM_L, _BCM_L	/* 240-255 */
};

ulong BCMROMFN (bcm_strtoul) (char *cp, char **endp, uint base)
{
  ulong result, value;
  bool minus;

  minus = FALSE;

  while (bcm_isspace (*cp))
    cp++;

  if (cp[0] == '+')
    cp++;
  else if (cp[0] == '-')
    {
      minus = TRUE;
      cp++;
    }

  if (base == 0)
    {
      if (cp[0] == '0')
	{
	  if ((cp[1] == 'x') || (cp[1] == 'X'))
	    {
	      base = 16;
	      cp = &cp[2];
	    }
	  else
	    {
	      base = 8;
	      cp = &cp[1];
	    }
	}
      else
	base = 10;
    }
  else if (base == 16 && (cp[0] == '0') && ((cp[1] == 'x') || (cp[1] == 'X')))
    {
      cp = &cp[2];
    }

  result = 0;

  while (bcm_isxdigit (*cp) &&
	 (value =
	  bcm_isdigit (*cp) ? *cp - '0' : bcm_toupper (*cp) - 'A' + 10) <
	 base)
    {
      result = result * base + value;
      cp++;
    }

  if (minus)
    result = (ulong) (result * -1);

  if (endp)
    *endp = (char *) cp;

  return (result);
}

#if 0
int BCMROMFN (bcm_atoi) (char *s)
{
  return (int) bcm_strtoul (s, NULL, 10);
}

/* return pointer to location of substring 'needle' in 'haystack' */
char *BCMROMFN (bcmstrstr) (char *haystack, char *needle)
{
  int len, nlen;
  int i;

  if ((haystack == NULL) || (needle == NULL))
    return (haystack);

  nlen = strlen (needle);
  len = strlen (haystack) - nlen + 1;

  for (i = 0; i < len; i++)
    if (memcmp (needle, &haystack[i], nlen) == 0)
      return (&haystack[i]);
  return (NULL);
}

char *BCMROMFN (bcmstrcat) (char *dest, const char *src)
{
  strcpy (&dest[strlen (dest)], src);
  return (dest);
}

char *BCMROMFN (bcmstrncat) (char *dest, const char *src, uint size)
{
  char *endp;
  char *p;

  p = dest + strlen (dest);
  endp = p + size;

  while (p != endp && (*p++ = *src++) != '\0')
    ;

  return (dest);
}
#endif

/* parse a xx:xx:xx:xx:xx:xx format ethernet address */
int BCMROMFN (bcm_ether_atoe) (char *p, struct ether_addr * ea)
{
  int i = 0;

  for (;;)
    {
      ea->octet[i++] = (char) bcm_strtoul (p, &p, 16);
      if (!*p++ || i == 6)
	break;
    }

  return (i == 6);
}

#if defined(CONFIG_USBRNDIS_RETAIL) || defined(NDIS_MINIPORT_DRIVER)
/* registry routine buffer preparation utility functions:
 * parameter order is like strncpy, but returns count
 * of bytes copied. Minimum bytes copied is null char(1)/wchar(2)
 */
ulong
wchar2ascii (char *abuf, ushort * wbuf, ushort wbuflen, ulong abuflen)
{
  ulong copyct = 1;
  ushort i;

  if (abuflen == 0)
    return 0;

  /* wbuflen is in bytes */
  wbuflen /= sizeof (ushort);

  for (i = 0; i < wbuflen; ++i)
    {
      if (--abuflen == 0)
	break;
      *abuf++ = (char) *wbuf++;
      ++copyct;
    }
  *abuf = '\0';

  return copyct;
}
#endif /* CONFIG_USBRNDIS_RETAIL || NDIS_MINIPORT_DRIVER */

#if 0
char *
bcm_ether_ntoa (struct ether_addr *ea, char *buf)
{
  snprintf (buf, 18, "%02x:%02x:%02x:%02x:%02x:%02x",
	    ea->octet[0] & 0xff, ea->octet[1] & 0xff, ea->octet[2] & 0xff,
	    ea->octet[3] & 0xff, ea->octet[4] & 0xff, ea->octet[5] & 0xff);
  return (buf);
}

char *
bcm_ip_ntoa (struct ipv4_addr *ia, char *buf)
{
  snprintf (buf, 16, "%d.%d.%d.%d",
	    ia->addr[0], ia->addr[1], ia->addr[2], ia->addr[3]);
  return (buf);
}
void
bcm_mdelay (uint ms)
{
  uint i;

  for (i = 0; i < ms; i++)
    {
      OSL_DELAY (1000);
    }
}
#endif

#if 0

/*
 * Search the name=value vars for a specific one and return its value.
 * Returns NULL if not found.
 */
char *
getvar (char *vars, const char *name)
{
#ifdef	_MINOSL_
  return NULL;
#else
  char *s;
  int len;

  if (!name)
    return NULL;

  len = strlen (name);
  if (len == 0)
    return NULL;

  /* first look in vars[] */
  for (s = vars; s && *s;)
    {
      /* CSTYLED */
      if ((bcmp (s, name, len) == 0) && (s[len] == '='))
	return (&s[len + 1]);

      while (*s++)
	;
    }

  /* then query nvram */
  return (nvram_get (name));
#endif /* _MINOSL_ */
}

/*
 * Search the vars for a specific one and return its value as
 * an integer. Returns 0 if not found.
 */
int
getintvar (char *vars, const char *name)
{
#ifdef	_MINOSL_
  return 0;
#else
  char *val;

  if ((val = getvar (vars, name)) == NULL)
    return (0);

  return (bcm_strtoul (val, NULL, 0));
#endif /* _MINOSL_ */
}


/* Search for token in comma separated token-string */
static int
findmatch (char *string, char *name)
{
  uint len;
  char *c;

  len = strlen (name);
  /* CSTYLED */
  while ((c = strchr (string, ',')) != NULL)
    {
      if (len == (uint) (c - string) && !strncmp (string, name, len))
	return 1;
      string = c + 1;
    }

  return (!strcmp (string, name));
}

/* Return gpio pin number assigned to the named pin
 *
 * Variable should be in format:
 *
 *	gpio<N>=pin_name,pin_name
 *
 * This format allows multiple features to share the gpio with mutual
 * understanding.
 *
 * 'def_pin' is returned if a specific gpio is not defined for the requested functionality
 * and if def_pin is not used by others.
 */
uint
getgpiopin (char *vars, char *pin_name, uint def_pin)
{
  char name[] = "gpioXXXX";
  char *val;
  uint pin;

  /* Go thru all possibilities till a match in pin name */
  for (pin = 0; pin < GPIO_NUMPINS; pin++)
    {
      snprintf (name, sizeof (name), "gpio%d", pin);
      val = getvar (vars, name);
      if (val && findmatch (val, pin_name))
	return pin;
    }

  if (def_pin != GPIO_PIN_NOTDEFINED)
    {
      /* make sure the default pin is not used by someone else */
      snprintf (name, sizeof (name), "gpio%d", def_pin);
      if (getvar (vars, name))
	{
	  def_pin = GPIO_PIN_NOTDEFINED;
	}
    }

  return def_pin;
}
#endif

#ifdef BCMPERFSTATS

#define	LOGSIZE	256		/* should be power of 2 to avoid div below */
static struct
{
  uint cycles;
  char *fmt;
  uint a1;
  uint a2;
} logtab[LOGSIZE];

/* last entry logged  */
static uint logi = 0;
/* next entry to read */
static uint readi = 0;

void
bcm_perf_enable ()
{
  BCMPERF_ENABLE_INSTRCOUNT ();
  BCMPERF_ENABLE_ICACHE_MISS ();
  BCMPERF_ENABLE_ICACHE_HIT ();
}

void
bcmlog (char *fmt, uint a1, uint a2)
{
  static uint last = 0;
  uint cycles, i;
  OSL_GETCYCLES (cycles);

  i = logi;

  logtab[i].cycles = cycles - last;
  logtab[i].fmt = fmt;
  logtab[i].a1 = a1;
  logtab[i].a2 = a2;

  logi = (i + 1) % LOGSIZE;
  last = cycles;
}


void
bcmstats (char *fmt)
{
  static uint last = 0;
  static uint32 ic_miss = 0;
  static uint32 instr_count = 0;
  uint32 ic_miss_cur;
  uint32 instr_count_cur;
  uint cycles, i;

  OSL_GETCYCLES (cycles);
  BCMPERF_GETICACHE_MISS (ic_miss_cur);
  BCMPERF_GETINSTRCOUNT (instr_count_cur);

  i = logi;

  logtab[i].cycles = cycles - last;
  logtab[i].a1 = ic_miss_cur - ic_miss;
  logtab[i].a2 = instr_count_cur - instr_count;
  logtab[i].fmt = fmt;

  logi = (i + 1) % LOGSIZE;

  last = cycles;
  instr_count = instr_count_cur;
  ic_miss = ic_miss_cur;
}


void
bcmdumplog (char *buf, int size)
{
  char *limit, *line;
  int j = 0;
  int num;

  limit = buf + size - 80;
  *buf = '\0';

  num = logi - readi;

  if (num < 0)
    num += LOGSIZE;

  /* print in chronological order */

  for (j = 0; j < num && (buf < limit); readi = (readi + 1) % LOGSIZE, j++)
    {
      if (logtab[readi].fmt == NULL)
	continue;
      line = buf;
      buf += sprintf (buf, "%d\t", logtab[readi].cycles);
      buf +=
	sprintf (buf, logtab[readi].fmt, logtab[readi].a1, logtab[readi].a2);
      buf += sprintf (buf, "\n");
    }

}


/*
 * Dump one log entry at a time.
 * Return index of next entry or -1 when no more .
 */
int
bcmdumplogent (char *buf, uint i)
{
  bool hit;

  /*
   * If buf is NULL, return the starting index,
   * interpreting i as the indicator of last 'i' entries to dump.
   */
  if (buf == NULL)
    {
      i = ((i > 0) && (i < (LOGSIZE - 1))) ? i : (LOGSIZE - 1);
      return ((logi - i) % LOGSIZE);
    }

  *buf = '\0';

  ASSERT (i < LOGSIZE);

  if (i == logi)
    return (-1);

  hit = FALSE;
  for (; (i != logi) && !hit; i = (i + 1) % LOGSIZE)
    {
      if (logtab[i].fmt == NULL)
	continue;
      buf += sprintf (buf, "%d: %d\t", i, logtab[i].cycles);
      buf += sprintf (buf, logtab[i].fmt, logtab[i].a1, logtab[i].a2);
      buf += sprintf (buf, "\n");
      hit = TRUE;
    }

  return (i);
}

#endif /* BCMPERFSTATS */

#ifdef BCMDBG
/* pretty hex print a pkt buffer chain */
void
prpkt (const char *msg, osl_t * osh, void *p0)
{
  void *p;

  if (msg && (msg[0] != '\0'))
    printf ("%s:\n", msg);

  for (p = p0; p; p = PKTNEXT (osh, p))
    prhex (NULL, PKTDATA (osh, p), PKTLEN (osh, p));
}
#endif /* BCMDBG */

/* Takes an Ethernet frame and sets out-of-bound PKTPRIO.
 * Also updates the inplace vlan tag if requested.
 * For debugging, it returns an indication of what it did.
 */
uint
pktsetprio (void *pkt, bool update_vtag)
{
  struct ether_header *eh;
  struct ethervlan_header *evh;
  uint8 *pktdata;
  int priority = 0;
  int rc = 0;

  pktdata = (uint8 *) PKTDATA (NULL, pkt);
  ASSERT (ISALIGNED ((uintptr) pktdata, sizeof (uint16)));

  eh = (struct ether_header *) pktdata;

  if (ntoh16 (eh->ether_type) == ETHER_TYPE_8021Q)
    {
      uint16 vlan_tag;
      int vlan_prio, dscp_prio = 0;

      evh = (struct ethervlan_header *) eh;

      vlan_tag = ntoh16 (evh->vlan_tag);
      vlan_prio = (int) (vlan_tag >> VLAN_PRI_SHIFT) & VLAN_PRI_MASK;

      if (ntoh16 (evh->ether_type) == ETHER_TYPE_IP)
	{
	  uint8 *ip_body = pktdata + sizeof (struct ethervlan_header);
	  uint8 tos_tc = IP_TOS (ip_body);
	  dscp_prio = (int) (tos_tc >> IPV4_TOS_PREC_SHIFT);
	  if ((IP_VER (ip_body) == IP_VER_4)
	      && (IPV4_PROT (ip_body) == IP_PROT_TCP))
	    {
	      int ip_len;
	      int src_port;
	      bool src_port_exc;
	      uint8 *tcp_hdr;

	      ip_len = IPV4_PAYLOAD_LEN (ip_body);
	      tcp_hdr = IPV4_NO_OPTIONS_PAYLOAD (ip_body);
	      src_port = TCP_SRC_PORT (tcp_hdr);
	      src_port_exc = (src_port == 10110) || (src_port == 10120) ||
		(src_port == 10130) || (src_port == 10140);

	      if ((ip_len == 40) && src_port_exc && TCP_IS_ACK (tcp_hdr))
		{
		  dscp_prio = 7;
		}
	    }
	}

      /* DSCP priority gets precedence over 802.1P (vlan tag) */
      if (dscp_prio != 0)
	{
	  priority = dscp_prio;
	  rc |= PKTPRIO_VDSCP;
	}
      else
	{
	  priority = vlan_prio;
	  rc |= PKTPRIO_VLAN;
	}
      /* 
       * If the DSCP priority is not the same as the VLAN priority,
       * then overwrite the priority field in the vlan tag, with the
       * DSCP priority value. This is required for Linux APs because
       * the VLAN driver on Linux, overwrites the skb->priority field
       * with the priority value in the vlan tag
       */
      if (update_vtag && (priority != vlan_prio))
	{
	  vlan_tag &= ~(VLAN_PRI_MASK << VLAN_PRI_SHIFT);
	  vlan_tag |= (uint16) priority << VLAN_PRI_SHIFT;
	  evh->vlan_tag = hton16 (vlan_tag);
	  rc |= PKTPRIO_UPD;
	}
    }
  else if (ntoh16 (eh->ether_type) == ETHER_TYPE_IP)
    {
      uint8 *ip_body = pktdata + sizeof (struct ether_header);
      uint8 tos_tc = IP_TOS (ip_body);
      priority = (int) (tos_tc >> IPV4_TOS_PREC_SHIFT);
      rc |= PKTPRIO_DSCP;
      if ((IP_VER (ip_body) == IP_VER_4)
	  && (IPV4_PROT (ip_body) == IP_PROT_TCP))
	{
	  int ip_len;
	  int src_port;
	  bool src_port_exc;
	  uint8 *tcp_hdr;

	  ip_len = IPV4_PAYLOAD_LEN (ip_body);
	  tcp_hdr = IPV4_NO_OPTIONS_PAYLOAD (ip_body);
	  src_port = TCP_SRC_PORT (tcp_hdr);
	  src_port_exc = (src_port == 10110) || (src_port == 10120) ||
	    (src_port == 10130) || (src_port == 10140);

	  if ((ip_len == 40) && src_port_exc && TCP_IS_ACK (tcp_hdr))
	    {
	      priority = 7;
	    }
	}
    }

  ASSERT (priority >= 0 && priority <= MAXPRIO);
  PKTSETPRIO (pkt, priority);
  return (rc | priority);
}

static char bcm_undeferrstr[BCME_STRLEN];

static const char *bcmerrorstrtable[] = BCMERRSTRINGTABLE;

/* Convert the error codes into related error strings  */
const char *
bcmerrorstr (int bcmerror)
{
  /* check if someone added a bcmerror code but forgot to add errorstring */
  ASSERT (ABS (BCME_LAST) == (ARRAYSIZE (bcmerrorstrtable) - 1));

  if (bcmerror > 0 || bcmerror < BCME_LAST)
    {
      snprintf (bcm_undeferrstr, BCME_STRLEN, "Undefined error %d", bcmerror);
      return bcm_undeferrstr;
    }

  ASSERT (strlen (bcmerrorstrtable[-bcmerror]) < BCME_STRLEN);

  return bcmerrorstrtable[-bcmerror];
}

#if 0
static void BCMINITFN (bcm_nvram_refresh) (char *flash)
{
  int i;
  int ret = 0;

  ASSERT (flash);

  /* default "empty" vars cache */
  bzero (flash, 2);

  if ((ret = nvram_getall (flash, NVRAM_SPACE)))
    return;

  /* determine nvram length */
  for (i = 0; i < NVRAM_SPACE; i++)
    {
      if (flash[i] == '\0' && flash[i + 1] == '\0')
	break;
    }

  if (i > 1)
    vars_len = i + 2;
  else
    vars_len = 0;
}
#endif

#ifdef BCMDBG_PKT		/* pkt logging for debugging */
/* Add a packet to the pktlist */
void
pktlist_add (pktlist_info_t * pktlist, void *pkt)
{
  uint i;
  ASSERT (pktlist->count < PKTLIST_SIZE);

  /* Verify the packet is not already part of the list */
  for (i = 0; i < pktlist->count; i++)
    {
      if (pktlist->list[i] == pkt)
	ASSERT (0);
    }
  pktlist->list[pktlist->count] = pkt;
  pktlist->count++;
  return;
}

/* Remove a packet from the pktlist */
void
pktlist_remove (pktlist_info_t * pktlist, void *pkt)
{
  uint i;
  uint num = pktlist->count;

  /* find the index where pkt exists */
  for (i = 0; i < num; i++)
    {
      /* check for the existence of pkt in the list */
      if (pktlist->list[i] == pkt)
	{
	  /* replace with the last element */
	  pktlist->list[i] = pktlist->list[num - 1];
	  pktlist->count--;
	  return;
	}
    }
  ASSERT (0);
}

/* Dump the pktlist (and the contents of each packet if 'data'
 * is set). 'buf' should be large enough
 */

char *
pktlist_dump (pktlist_info_t * pktlist, char *buf)
{
  char *obuf;
  uint i;

  obuf = buf;

  buf += sprintf (buf, "Packet list dump:\n");

  for (i = 0; i < (pktlist->count); i++)
    {
      buf += sprintf (buf, "0x%p\t", pktlist->list[i]);

#ifdef NOTDEF			/* Remove this ifdef to print pkttag and pktdata */
      if (PKTTAG (pktlist->list[i]))
	{
	  /* Print pkttag */
	  buf += sprintf (buf, "Pkttag(in hex): ");
	  buf +=
	    bcm_format_hex (buf, PKTTAG (pktlist->list[i]), OSL_PKTTAG_SZ);
	}
      buf += sprintf (buf, "Pktdata(in hex): ");
      buf += bcm_format_hex (buf, PKTDATA (NULL, pktlist->list[i]),
			     PKTLEN (NULL, pktlist->list[i]));
#endif /* NOTDEF */

      buf += sprintf (buf, "\n");
    }
  return obuf;
}
#endif /* BCMDBG_PKT */

#if 0
/* iovar table lookup */
const bcm_iovar_t *
bcm_iovar_lookup (const bcm_iovar_t * table, const char *name)
{
  const bcm_iovar_t *vi;
  const char *lookup_name;

  /* skip any ':' delimited option prefixes */
  lookup_name = strrchr (name, ':');
  if (lookup_name != NULL)
    lookup_name++;
  else
    lookup_name = name;

  ASSERT (table);

  for (vi = table; vi->name; vi++)
    {
      if (!strcmp (vi->name, lookup_name))
	return vi;
    }
  /* ran to end of table */

  return NULL;			/* var name not found */
}
#endif

int
bcm_iovar_lencheck (const bcm_iovar_t * vi, void *arg, int len, bool set)
{
  int bcmerror = 0;

  /* length check on io buf */
  switch (vi->type)
    {
    case IOVT_BOOL:
    case IOVT_INT8:
    case IOVT_INT16:
    case IOVT_INT32:
    case IOVT_UINT8:
    case IOVT_UINT16:
    case IOVT_UINT32:
      /* all integers are int32 sized args at the ioctl interface */
      if (len < (int) sizeof (int))
	{
	  bcmerror = BCME_BUFTOOSHORT;
	}
      break;

    case IOVT_BUFFER:
      /* buffer must meet minimum length requirement */
      if (len < vi->minlen)
	{
	  bcmerror = BCME_BUFTOOSHORT;
	}
      break;

    case IOVT_VOID:
      if (!set)
	{
	  /* Cannot return nil... */
	  bcmerror = BCME_UNSUPPORTED;
	}
      else if (len)
	{
	  /* Set is an action w/o parameters */
	  bcmerror = BCME_BUFTOOLONG;
	}
      break;

    default:
      /* unknown type for length check in iovar info */
      ASSERT (0);
      bcmerror = BCME_UNSUPPORTED;
    }

  return bcmerror;
}

#define CRC_INNER_LOOP(n, c, x) \
	(c) = ((c) >> 8) ^ crc##n##_table[((c) ^ (x)) & 0xff]

#if 0
/*******************************************************************************
 * crc8
 *
 * Computes a crc8 over the input data using the polynomial:
 *
 *       x^8 + x^7 +x^6 + x^4 + x^2 + 1
 *
 * The caller provides the initial value (either CRC8_INIT_VALUE
 * or the previous returned value) to allow for processing of
 * discontiguous blocks of data.  When generating the CRC the
 * caller is responsible for complementing the final return value
 * and inserting it into the byte stream.  When checking, a final
 * return value of CRC8_GOOD_VALUE indicates a valid CRC.
 *
 * Reference: Dallas Semiconductor Application Note 27
 *   Williams, Ross N., "A Painless Guide to CRC Error Detection Algorithms",
 *     ver 3, Aug 1993, ross@guest.adelaide.edu.au, Rocksoft Pty Ltd.,
 *     ftp://ftp.rocksoft.com/clients/rocksoft/papers/crc_v3.txt
 *
 * ****************************************************************************
 */

static const uint8 crc8_table[256] = {
  0x00, 0xF7, 0xB9, 0x4E, 0x25, 0xD2, 0x9C, 0x6B,
  0x4A, 0xBD, 0xF3, 0x04, 0x6F, 0x98, 0xD6, 0x21,
  0x94, 0x63, 0x2D, 0xDA, 0xB1, 0x46, 0x08, 0xFF,
  0xDE, 0x29, 0x67, 0x90, 0xFB, 0x0C, 0x42, 0xB5,
  0x7F, 0x88, 0xC6, 0x31, 0x5A, 0xAD, 0xE3, 0x14,
  0x35, 0xC2, 0x8C, 0x7B, 0x10, 0xE7, 0xA9, 0x5E,
  0xEB, 0x1C, 0x52, 0xA5, 0xCE, 0x39, 0x77, 0x80,
  0xA1, 0x56, 0x18, 0xEF, 0x84, 0x73, 0x3D, 0xCA,
  0xFE, 0x09, 0x47, 0xB0, 0xDB, 0x2C, 0x62, 0x95,
  0xB4, 0x43, 0x0D, 0xFA, 0x91, 0x66, 0x28, 0xDF,
  0x6A, 0x9D, 0xD3, 0x24, 0x4F, 0xB8, 0xF6, 0x01,
  0x20, 0xD7, 0x99, 0x6E, 0x05, 0xF2, 0xBC, 0x4B,
  0x81, 0x76, 0x38, 0xCF, 0xA4, 0x53, 0x1D, 0xEA,
  0xCB, 0x3C, 0x72, 0x85, 0xEE, 0x19, 0x57, 0xA0,
  0x15, 0xE2, 0xAC, 0x5B, 0x30, 0xC7, 0x89, 0x7E,
  0x5F, 0xA8, 0xE6, 0x11, 0x7A, 0x8D, 0xC3, 0x34,
  0xAB, 0x5C, 0x12, 0xE5, 0x8E, 0x79, 0x37, 0xC0,
  0xE1, 0x16, 0x58, 0xAF, 0xC4, 0x33, 0x7D, 0x8A,
  0x3F, 0xC8, 0x86, 0x71, 0x1A, 0xED, 0xA3, 0x54,
  0x75, 0x82, 0xCC, 0x3B, 0x50, 0xA7, 0xE9, 0x1E,
  0xD4, 0x23, 0x6D, 0x9A, 0xF1, 0x06, 0x48, 0xBF,
  0x9E, 0x69, 0x27, 0xD0, 0xBB, 0x4C, 0x02, 0xF5,
  0x40, 0xB7, 0xF9, 0x0E, 0x65, 0x92, 0xDC, 0x2B,
  0x0A, 0xFD, 0xB3, 0x44, 0x2F, 0xD8, 0x96, 0x61,
  0x55, 0xA2, 0xEC, 0x1B, 0x70, 0x87, 0xC9, 0x3E,
  0x1F, 0xE8, 0xA6, 0x51, 0x3A, 0xCD, 0x83, 0x74,
  0xC1, 0x36, 0x78, 0x8F, 0xE4, 0x13, 0x5D, 0xAA,
  0x8B, 0x7C, 0x32, 0xC5, 0xAE, 0x59, 0x17, 0xE0,
  0x2A, 0xDD, 0x93, 0x64, 0x0F, 0xF8, 0xB6, 0x41,
  0x60, 0x97, 0xD9, 0x2E, 0x45, 0xB2, 0xFC, 0x0B,
  0xBE, 0x49, 0x07, 0xF0, 0x9B, 0x6C, 0x22, 0xD5,
  0xF4, 0x03, 0x4D, 0xBA, 0xD1, 0x26, 0x68, 0x9F
};

uint8 BCMROMFN (hndcrc8) (uint8 * pdata,	/* pointer to array of data to process */
			  uint nbytes,	/* number of input data bytes to process */
			  uint8 crc	/* either CRC8_INIT_VALUE or previous return value */
  )
{
  /* hard code the crc loop instead of using CRC_INNER_LOOP macro
   * to avoid the undefined and unnecessary (uint8 >> 8) operation.
   */
  while (nbytes-- > 0)
    crc = crc8_table[(crc ^ *pdata++) & 0xff];

  return crc;
}

/*******************************************************************************
 * crc16
 *
 * Computes a crc16 over the input data using the polynomial:
 *
 *       x^16 + x^12 +x^5 + 1
 *
 * The caller provides the initial value (either CRC16_INIT_VALUE
 * or the previous returned value) to allow for processing of
 * discontiguous blocks of data.  When generating the CRC the
 * caller is responsible for complementing the final return value
 * and inserting it into the byte stream.  When checking, a final
 * return value of CRC16_GOOD_VALUE indicates a valid CRC.
 *
 * Reference: Dallas Semiconductor Application Note 27
 *   Williams, Ross N., "A Painless Guide to CRC Error Detection Algorithms",
 *     ver 3, Aug 1993, ross@guest.adelaide.edu.au, Rocksoft Pty Ltd.,
 *     ftp://ftp.rocksoft.com/clients/rocksoft/papers/crc_v3.txt
 *
 * ****************************************************************************
 */
static const uint16 crc16_table[256] = {
  0x0000, 0x1189, 0x2312, 0x329B, 0x4624, 0x57AD, 0x6536, 0x74BF,
  0x8C48, 0x9DC1, 0xAF5A, 0xBED3, 0xCA6C, 0xDBE5, 0xE97E, 0xF8F7,
  0x1081, 0x0108, 0x3393, 0x221A, 0x56A5, 0x472C, 0x75B7, 0x643E,
  0x9CC9, 0x8D40, 0xBFDB, 0xAE52, 0xDAED, 0xCB64, 0xF9FF, 0xE876,
  0x2102, 0x308B, 0x0210, 0x1399, 0x6726, 0x76AF, 0x4434, 0x55BD,
  0xAD4A, 0xBCC3, 0x8E58, 0x9FD1, 0xEB6E, 0xFAE7, 0xC87C, 0xD9F5,
  0x3183, 0x200A, 0x1291, 0x0318, 0x77A7, 0x662E, 0x54B5, 0x453C,
  0xBDCB, 0xAC42, 0x9ED9, 0x8F50, 0xFBEF, 0xEA66, 0xD8FD, 0xC974,
  0x4204, 0x538D, 0x6116, 0x709F, 0x0420, 0x15A9, 0x2732, 0x36BB,
  0xCE4C, 0xDFC5, 0xED5E, 0xFCD7, 0x8868, 0x99E1, 0xAB7A, 0xBAF3,
  0x5285, 0x430C, 0x7197, 0x601E, 0x14A1, 0x0528, 0x37B3, 0x263A,
  0xDECD, 0xCF44, 0xFDDF, 0xEC56, 0x98E9, 0x8960, 0xBBFB, 0xAA72,
  0x6306, 0x728F, 0x4014, 0x519D, 0x2522, 0x34AB, 0x0630, 0x17B9,
  0xEF4E, 0xFEC7, 0xCC5C, 0xDDD5, 0xA96A, 0xB8E3, 0x8A78, 0x9BF1,
  0x7387, 0x620E, 0x5095, 0x411C, 0x35A3, 0x242A, 0x16B1, 0x0738,
  0xFFCF, 0xEE46, 0xDCDD, 0xCD54, 0xB9EB, 0xA862, 0x9AF9, 0x8B70,
  0x8408, 0x9581, 0xA71A, 0xB693, 0xC22C, 0xD3A5, 0xE13E, 0xF0B7,
  0x0840, 0x19C9, 0x2B52, 0x3ADB, 0x4E64, 0x5FED, 0x6D76, 0x7CFF,
  0x9489, 0x8500, 0xB79B, 0xA612, 0xD2AD, 0xC324, 0xF1BF, 0xE036,
  0x18C1, 0x0948, 0x3BD3, 0x2A5A, 0x5EE5, 0x4F6C, 0x7DF7, 0x6C7E,
  0xA50A, 0xB483, 0x8618, 0x9791, 0xE32E, 0xF2A7, 0xC03C, 0xD1B5,
  0x2942, 0x38CB, 0x0A50, 0x1BD9, 0x6F66, 0x7EEF, 0x4C74, 0x5DFD,
  0xB58B, 0xA402, 0x9699, 0x8710, 0xF3AF, 0xE226, 0xD0BD, 0xC134,
  0x39C3, 0x284A, 0x1AD1, 0x0B58, 0x7FE7, 0x6E6E, 0x5CF5, 0x4D7C,
  0xC60C, 0xD785, 0xE51E, 0xF497, 0x8028, 0x91A1, 0xA33A, 0xB2B3,
  0x4A44, 0x5BCD, 0x6956, 0x78DF, 0x0C60, 0x1DE9, 0x2F72, 0x3EFB,
  0xD68D, 0xC704, 0xF59F, 0xE416, 0x90A9, 0x8120, 0xB3BB, 0xA232,
  0x5AC5, 0x4B4C, 0x79D7, 0x685E, 0x1CE1, 0x0D68, 0x3FF3, 0x2E7A,
  0xE70E, 0xF687, 0xC41C, 0xD595, 0xA12A, 0xB0A3, 0x8238, 0x93B1,
  0x6B46, 0x7ACF, 0x4854, 0x59DD, 0x2D62, 0x3CEB, 0x0E70, 0x1FF9,
  0xF78F, 0xE606, 0xD49D, 0xC514, 0xB1AB, 0xA022, 0x92B9, 0x8330,
  0x7BC7, 0x6A4E, 0x58D5, 0x495C, 0x3DE3, 0x2C6A, 0x1EF1, 0x0F78
};

uint16 BCMROMFN (hndcrc16) (uint8 * pdata,	/* pointer to array of data to process */
			    uint nbytes,	/* number of input data bytes to process */
			    uint16 crc	/* either CRC16_INIT_VALUE or previous return value */
  )
{
  while (nbytes-- > 0)
    CRC_INNER_LOOP (16, crc, *pdata++);
  return crc;
}
#endif

static const uint32 crc32_table[256] = {
  0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA,
  0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3,
  0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988,
  0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91,
  0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE,
  0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7,
  0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC,
  0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5,
  0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172,
  0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
  0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940,
  0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59,
  0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116,
  0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
  0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924,
  0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
  0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A,
  0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433,
  0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818,
  0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
  0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E,
  0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457,
  0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C,
  0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65,
  0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2,
  0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB,
  0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0,
  0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
  0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086,
  0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
  0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4,
  0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
  0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A,
  0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683,
  0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8,
  0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1,
  0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE,
  0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7,
  0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC,
  0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
  0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252,
  0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
  0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60,
  0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79,
  0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236,
  0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F,
  0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04,
  0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
  0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A,
  0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
  0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38,
  0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21,
  0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E,
  0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777,
  0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C,
  0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
  0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2,
  0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB,
  0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0,
  0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
  0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6,
  0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF,
  0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94,
  0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D
};

uint32 BCMROMFN (hndcrc32) (uint8 * pdata,	/* pointer to array of data to process */
			    uint nbytes,	/* number of input data bytes to process */
			    uint32 crc	/* either CRC32_INIT_VALUE or previous return value */
  )
{
  uint8 *pend;
#ifdef __mips__
  uint8 tmp[4];
  ulong *tptr = (ulong *) tmp;

  /* in case the beginning of the buffer isn't aligned */
  pend = (uint8 *) ((uint) (pdata + 3) & 0xfffffffc);
  nbytes -= (pend - pdata);
  while (pdata < pend)
    CRC_INNER_LOOP (32, crc, *pdata++);

  /* handle bulk of data as 32-bit words */
  pend = pdata + (nbytes & 0xfffffffc);
  while (pdata < pend)
    {
      *tptr = *(ulong *) pdata;
      pdata += sizeof (ulong *);
      CRC_INNER_LOOP (32, crc, tmp[0]);
      CRC_INNER_LOOP (32, crc, tmp[1]);
      CRC_INNER_LOOP (32, crc, tmp[2]);
      CRC_INNER_LOOP (32, crc, tmp[3]);
    }

  /* 1-3 bytes at end of buffer */
  pend = pdata + (nbytes & 0x03);
  while (pdata < pend)
    CRC_INNER_LOOP (32, crc, *pdata++);
#else
  pend = pdata + nbytes;
  while (pdata < pend)
    CRC_INNER_LOOP (32, crc, *pdata++);
#endif /* __mips__ */

  return crc;
}

#ifdef notdef
#define CLEN 	1499		/*  CRC Length */
#define CBUFSIZ 	(CLEN+4)
#define CNBUFS		5	/* # of bufs */

void
testcrc32 (void)
{
  uint j, k, l;
  uint8 *buf;
  uint len[CNBUFS];
  uint32 crcr;
  uint32 crc32tv[CNBUFS] =
    { 0xd2cb1faa, 0xd385c8fa, 0xf5b4f3f3, 0x55789e20, 0x00343110 };

  ASSERT ((buf = MALLOC (CBUFSIZ * CNBUFS)) != NULL);

  /* step through all possible alignments */
  for (l = 0; l <= 4; l++)
    {
      for (j = 0; j < CNBUFS; j++)
	{
	  len[j] = CLEN;
	  for (k = 0; k < len[j]; k++)
	    *(buf + j * CBUFSIZ + (k + l)) = (j + k) & 0xff;
	}

      for (j = 0; j < CNBUFS; j++)
	{
	  crcr = crc32 (buf + j * CBUFSIZ + l, len[j], CRC32_INIT_VALUE);
	  ASSERT (crcr == crc32tv[j]);
	}
    }

  MFREE (buf, CBUFSIZ * CNBUFS);
  return;
}
#endif /* notdef */

/*
 * Advance from the current 1-byte tag/1-byte length/variable-length value
 * triple, to the next, returning a pointer to the next.
 * If the current or next TLV is invalid (does not fit in given buffer length),
 * NULL is returned.
 * *buflen is not modified if the TLV elt parameter is invalid, or is decremented
 * by the TLV parameter's length if it is valid.
 */
bcm_tlv_t *BCMROMFN (bcm_next_tlv) (bcm_tlv_t * elt, int *buflen)
{
  int len;

  /* validate current elt */
  if (!bcm_valid_tlv (elt, *buflen))
    return NULL;

  /* advance to next elt */
  len = elt->len;
  elt = (bcm_tlv_t *) (elt->data + len);
  *buflen -= (2 + len);

  /* validate next elt */
  if (!bcm_valid_tlv (elt, *buflen))
    return NULL;

  return elt;
}

/*
 * Traverse a string of 1-byte tag/1-byte length/variable-length value
 * triples, returning a pointer to the substring whose first element
 * matches tag
 */
bcm_tlv_t *BCMROMFN (bcm_parse_tlvs) (void *buf, int buflen, uint key)
{
  bcm_tlv_t *elt;
  int totlen;

  elt = (bcm_tlv_t *) buf;
  totlen = buflen;

  /* find tagged parameter */
  while (totlen >= 2)
    {
      int len = elt->len;

      /* validate remaining totlen */
      if ((elt->id == key) && (totlen >= (len + 2)))
	return (elt);

      elt = (bcm_tlv_t *) ((uint8 *) elt + (len + 2));
      totlen -= (len + 2);
    }

  return NULL;
}

#if 0
/*
 * Traverse a string of 1-byte tag/1-byte length/variable-length value
 * triples, returning a pointer to the substring whose first element
 * matches tag.  Stop parsing when we see an element whose ID is greater
 * than the target key.
 */
bcm_tlv_t *BCMROMFN (bcm_parse_ordered_tlvs) (void *buf, int buflen, uint key)
{
  bcm_tlv_t *elt;
  int totlen;

  elt = (bcm_tlv_t *) buf;
  totlen = buflen;

  /* find tagged parameter */
  while (totlen >= 2)
    {
      uint id = elt->id;
      int len = elt->len;

      /* Punt if we start seeing IDs > than target key */
      if (id > key)
	return (NULL);

      /* validate remaining totlen */
      if ((id == key) && (totlen >= (len + 2)))
	return (elt);

      elt = (bcm_tlv_t *) ((uint8 *) elt + (len + 2));
      totlen -= (len + 2);
    }
  return NULL;
}

#ifdef BCMDBG
int
bcm_format_flags (const bcm_bit_desc_t * bd, uint32 flags, char *buf, int len)
{
  int i;
  char *p = buf;
  char hexstr[16];
  int slen = 0;
  uint32 bit;
  const char *name;

  if (len < 2 || !buf)
    return 0;

  buf[0] = '\0';
  len -= 1;

  for (i = 0; flags != 0; i++)
    {
      bit = bd[i].bit;
      name = bd[i].name;
      if (bit == 0 && flags)
	{
	  /* print any unnamed bits */
	  sprintf (hexstr, "0x%X", flags);
	  name = hexstr;
	  flags = 0;		/* exit loop */
	}
      else if ((flags & bit) == 0)
	continue;
      slen += strlen (name);
      if (len < slen)
	break;
      if (p != buf)
	p += sprintf (p, " ");	/* btwn flag space */
      strcat (p, name);
      p += strlen (name);
      flags &= ~bit;
      len -= slen;
      slen = 1;			/* account for btwn flag space */
    }

  /* indicate the str was too short */
  if (flags != 0)
    {
      if (len == 0)
	p--;			/* overwrite last char */
      p += sprintf (p, ">");
    }

  return (int) (p - buf);
}

void
deadbeef (void *p, uint len)
{
  static uint8 meat[] = { 0xde, 0xad, 0xbe, 0xef };

  while (len-- > 0)
    {
      *(uint8 *) p = meat[((uintptr) p) & 3];
      p = (uint8 *) p + 1;
    }
}

/* pretty hex print a contiguous buffer */
void
prhex (const char *msg, uchar * buf, uint nbytes)
{
  char line[128], *p;
  uint i;

  if (msg && (msg[0] != '\0'))
    printf ("%s:\n", msg);

  p = line;
  for (i = 0; i < nbytes; i++)
    {
      if (i % 16 == 0)
	{
	  p += sprintf (p, "  %04d: ", i);	/* line prefix */
	}
      p += sprintf (p, "%02x ", buf[i]);
      if (i % 16 == 15)
	{
	  printf ("%s\n", line);	/* flush line */
	  p = line;
	}
    }

  /* flush last partial line */
  if (p != line)
    printf ("%s\n", line);
}

/* print bytes formatted as hex to a string. return the resulting string length */
int
bcm_format_hex (char *str, const void *bytes, int len)
{
  int i;
  char *p = str;
  const uint8 *src = (const uint8 *) bytes;

  for (i = 0; i < len; i++)
    {
      p += sprintf (p, "%02X", *src);
      src++;
    }
  return (int) (p - str);
}

#endif /* BCMDBG */

/* Produce a human-readable string for boardrev */
char *
bcm_brev_str (uint16 brev, char *buf)
{
  if (brev < 0x100)
    snprintf (buf, 8, "%d.%d", (brev & 0xf0) >> 4, brev & 0xf);
  else
    snprintf (buf, 8, "%c%03x", ((brev & 0xf000) == 0x1000) ? 'P' : 'A',
	      brev & 0xfff);

  return (buf);
}

#define BUFSIZE_TODUMP_ATONCE 512	/* Buffer size */

/* dump large strings to console */
void
printfbig (char *buf)
{
  uint len, max_len;
  char c;

  len = strlen (buf);

  max_len = BUFSIZE_TODUMP_ATONCE;

  while (len > max_len)
    {
      c = buf[max_len];
      buf[max_len] = '\0';
      printf ("%s", buf);
      buf[max_len] = c;

      buf += max_len;
      len -= max_len;
    }
  /* print the remaining string */
  printf ("%s\n", buf);
  return;
}

/* routine to dump fields in a fileddesc structure */
uint
bcmdumpfields (readreg_rtn read_rtn, void *arg0, void *arg1,
	       struct fielddesc * fielddesc_array, char *buf, uint32 bufsize)
{
  uint filled_len;
  int len;
  struct fielddesc *cur_ptr;

  filled_len = 0;
  cur_ptr = fielddesc_array;

  while (bufsize > 1)
    {
      if (cur_ptr->nameandfmt == NULL)
	break;
      len = snprintf (buf, bufsize, cur_ptr->nameandfmt,
		      read_rtn (arg0, arg1, cur_ptr->offset));
      /* check for snprintf overflow or error */
      if (len < 0 || (uint32) len >= bufsize)
	len = bufsize - 1;
      buf += len;
      bufsize -= len;
      filled_len += len;
      cur_ptr++;
    }
  return filled_len;
}
#endif

uint
bcm_mkiovar (char *name, char *data, uint datalen, char *buf, uint buflen)
{
  uint len;

  len = strlen (name) + 1;

  if ((len + datalen) > buflen)
    return 0;

  strncpy (buf, name, buflen);

  /* append data onto the end of the name string */
  memcpy (&buf[len], data, datalen);
  len += datalen;

  return len;
}

/* Quarter dBm units to mW
 * Table starts at QDBM_OFFSET, so the first entry is mW for qdBm=153
 * Table is offset so the last entry is largest mW value that fits in
 * a uint16.
 */

#define QDBM_OFFSET 153		/* Offset for first entry */
#define QDBM_TABLE_LEN 40	/* Table size */

/* Smallest mW value that will round up to the first table entry, QDBM_OFFSET.
 * Value is ( mW(QDBM_OFFSET - 1) + mW(QDBM_OFFSET) ) / 2
 */
#define QDBM_TABLE_LOW_BOUND 6493	/* Low bound */

/* Largest mW value that will round down to the last table entry,
 * QDBM_OFFSET + QDBM_TABLE_LEN-1.
 * Value is ( mW(QDBM_OFFSET + QDBM_TABLE_LEN - 1) + mW(QDBM_OFFSET + QDBM_TABLE_LEN) ) / 2.
 */
#define QDBM_TABLE_HIGH_BOUND 64938	/* High bound */

static const uint16 nqdBm_to_mW_map[QDBM_TABLE_LEN] = {
/* qdBm: 	+0 	+1 	+2 	+3 	+4 	+5 	+6 	+7 */
/* 153: */ 6683, 7079, 7499, 7943, 8414, 8913, 9441, 10000,
/* 161: */ 10593, 11220, 11885, 12589, 13335, 14125, 14962, 15849,
/* 169: */ 16788, 17783, 18836, 19953, 21135, 22387, 23714, 25119,
/* 177: */ 26607, 28184, 29854, 31623, 33497, 35481, 37584, 39811,
/* 185: */ 42170, 44668, 47315, 50119, 53088, 56234, 59566, 63096
};

uint16 BCMROMFN (bcm_qdbm_to_mw) (uint8 qdbm)
{
  uint factor = 1;
  int idx = qdbm - QDBM_OFFSET;

  if (idx > QDBM_TABLE_LEN)
    {
      /* clamp to max uint16 mW value */
      return 0xFFFF;
    }

  /* scale the qdBm index up to the range of the table 0-40
   * where an offset of 40 qdBm equals a factor of 10 mW.
   */
  while (idx < 0)
    {
      idx += 40;
      factor *= 10;
    }

  /* return the mW value scaled down to the correct factor of 10,
   * adding in factor/2 to get proper rounding.
   */
  return ((nqdBm_to_mW_map[idx] + factor / 2) / factor);
}

uint8 BCMROMFN (bcm_mw_to_qdbm) (uint16 mw)
{
  uint8 qdbm;
  int offset;
  uint mw_uint = mw;
  uint boundary;

  /* handle boundary case */
  if (mw_uint <= 1)
    return 0;

  offset = QDBM_OFFSET;

  /* move mw into the range of the table */
  while (mw_uint < QDBM_TABLE_LOW_BOUND)
    {
      mw_uint *= 10;
      offset -= 40;
    }

  for (qdbm = 0; qdbm < QDBM_TABLE_LEN - 1; qdbm++)
    {
      boundary = nqdBm_to_mW_map[qdbm] + (nqdBm_to_mW_map[qdbm + 1] -
					  nqdBm_to_mW_map[qdbm]) / 2;
      if (mw_uint < boundary)
	break;
    }

  qdbm += (uint8) offset;

  return (qdbm);
}


uint BCMROMFN (bcm_bitcount) (uint8 * bitmap, uint length)
{
  uint bitcount = 0, i;
  uint8 tmp;
  for (i = 0; i < length; i++)
    {
      tmp = bitmap[i];
      while (tmp)
	{
	  bitcount++;
	  tmp &= (tmp - 1);
	}
    }
  return bitcount;
}


/* Initialization of bcmstrbuf structure */
void
bcm_binit (struct bcmstrbuf *b, char *buf, uint size)
{
  b->origsize = b->size = size;
  b->origbuf = b->buf = buf;
}

/* Buffer sprintf wrapper to guard against buffer overflow */
int
bcm_bprintf (struct bcmstrbuf *b, const char *fmt, ...)
{
  va_list ap;
  int r;

  va_start (ap, fmt);
  r = vsnprintf (b->buf, b->size, fmt, ap);

  /* Non Ansi C99 compliant returns -1,
   * Ansi compliant return r >= b->size,
   * bcmstdlib returns 0, handle all
   */
  if ((r == -1) || (r >= (int) b->size) || (r == 0))
    {
      b->size = 0;
    }
  else
    {
      b->size -= r;
      b->buf += r;
    }

  va_end (ap);

  return r;
}

char *
bcm_ether_ntoa (struct ether_addr *ea, char *buf)
{
	snprintf (buf, 18, "%02x:%02x:%02x:%02x:%02x:%02x",
		ea->octet[0] & 0xff, ea->octet[1] & 0xff, ea->octet[2] & 0xff,
		ea->octet[3] & 0xff, ea->octet[4] & 0xff, ea->octet[5] & 0xff);
	return (buf);
}

