workbench/devs/networks/realtek8180/eeprom.c

   1 /*
   2
   3 Copyright (C) 2001-2011 Neil Cafferkey
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful, but
  11 WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13 General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  18 MA 02111-1307, USA.
  19
  20 */
  21
  22
  23 #include "device.h"
  24
  25 #include "eeprom_protos.h"
  26 #include "timer_protos.h"
  27 #include "realtek8187.h"
  28
  29
  30 static ULONG ReadEEPROMBits(struct DevUnit *unit, UBYTE count,
  31    struct DevBase *base);
  32 static VOID WriteEEPROMBits(struct DevUnit *unit, ULONG value, UBYTE count,
  33    struct DevBase *base);
  34 static BOOL ReadEEPROMBit(struct DevUnit *unit, struct DevBase *base);
  35 static BOOL WriteEEPROMBit(struct DevUnit *unit, BOOL is_one,
  36    struct DevBase *base);
  37
  38
  39 /****i* realtek8180.device/GetEEPROMAddressSize ****************************
  40 *
  41 *   NAME
  42 *       GetEEPROMAddressSize
  43 *
  44 *   SYNOPSIS
  45 *       size = GetEEPROMAddressSize(unit)
  46 *
  47 *       UWORD GetEEPROMAddressSize(struct DevUnit *);
  48 *
  49 *   INPUTS
  50 *       unit - A unit of this device.
  51 *
  52 *   RESULT
  53 *       size - Width of EEPROM addresses.
  54 *
  55 ****************************************************************************
  56 *
  57 */
  58
  59 #if 0
  60 static UWORD GetEEPROMAddressSize(struct DevUnit *unit,
  61    struct DevBase *base)
  62 {
  63    UWORD size;
  64
  65    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM, R8180REG_EEPROMF_SELECT);
  66    WriteEEPROMBits(unit, 0x6, 3, base);
  67    for(size = 1; WriteEEPROMBit(unit, FALSE, base); size++);
  68    ReadEEPROMBits(unit, 16, base);
  69    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM, 0);
  70    BusyMicroDelay(1, base);
  71
  72    return size;
  73 }
  74 #endif
  75
  76
  77
  78 /****i* realtek8180.device/ReadEEPROM **************************************
  79 *
  80 *   NAME
  81 *       ReadEEPROM -- Read an EEPROM location.
  82 *
  83 *   SYNOPSIS
  84 *       value = ReadEEPROM(unit, index)
  85 *
  86 *       UWORD ReadEEPROM(struct DevUnit *, UWORD);
  87 *
  88 *   INPUTS
  89 *       unit - A unit of this device.
  90 *       index - Offset within EEPROM.
  91 *
  92 *   RESULT
  93 *       value - Contents of specified EEPROM location.
  94 *
  95 ****************************************************************************
  96 *
  97 */
  98
  99 UWORD ReadEEPROM(struct DevUnit *unit, UWORD index,
 100    struct DevBase *base)
 101 {
 102    UWORD value;
 103
 104    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM,
 105       R8180ECMD_PROGRAM | R8180REG_EEPROMF_SELECT);
 106    WriteEEPROMBits(unit, 0x6, 3, base);
 107    WriteEEPROMBits(unit, index, unit->eeprom_addr_size, base);
 108    value = ReadEEPROMBits(unit, 16, base);
 109    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM, R8180ECMD_PROGRAM);
 110    BusyMicroDelay(1, base);
 111
 112    return value;
 113 }
 114
 115
 116
 117 /****i* realtek8180.device/ReadEEPROMBits **********************************
 118 *
 119 *   NAME
 120 *       ReadEEPROMBits -- Read a stream of bits from the EEPROM.
 121 *
 122 *   SYNOPSIS
 123 *       value = ReadEEPROMBits(unit, count)
 124 *
 125 *       ULONG ReadEEPROMBits(struct DevUnit *, UBYTE);
 126 *
 127 *   INPUTS
 128 *       unit - A unit of this device.
 129 *       count - Number of bits to be read.
 130 *
 131 *   RESULT
 132 *       value - The bits read from the EEPROM, right-justified.
 133 *
 134 ****************************************************************************
 135 *
 136 */
 137
 138 static ULONG ReadEEPROMBits(struct DevUnit *unit, UBYTE count,
 139    struct DevBase *base)
 140 {
 141    UBYTE i;
 142    ULONG value = 0;
 143
 144    for(i = 0; i < count; i++)
 145    {
 146       value <<= 1;
 147       if(ReadEEPROMBit(unit, base))
 148          value |= 0x1;
 149    }
 150
 151    return value;
 152 }
 153
 154
 155 /****i* realtek8180.device/WriteEEPROMBits *********************************
 156 *
 157 *   NAME
 158 *       WriteEEPROMBits -- Write a stream of bits to the EEPROM.
 159 *
 160 *   SYNOPSIS
 161 *       WriteEEPROMBits(unit, value, count)
 162 *
 163 *       VOID WriteEEPROMBits(struct DevUnit *, ULONG, UBYTE);
 164 *
 165 *   INPUTS
 166 *       unit - A unit of this device.
 167 *       value - The bits to write to the EEPROM, right-justified.
 168 *       count - Number of bits to be Write.
 169 *
 170 *   RESULT
 171 *       None.
 172 *
 173 ****************************************************************************
 174 *
 175 */
 176
 177 static VOID WriteEEPROMBits(struct DevUnit *unit, ULONG value, UBYTE count,
 178    struct DevBase *base)
 179 {
 180    ULONG mask;
 181
 182    for(mask = 1 << (count - 1); mask != 0; mask >>= 1)
 183       WriteEEPROMBit(unit, (value & mask) != 0, base);
 184
 185    return;
 186 }
 187
 188
 189
 190 /****i* realtek8180.device/ReadEEPROMBit ***********************************
 191 *
 192 *   NAME
 193 *       ReadEEPROMBit -- Read a bit from the EEPROM.
 194 *
 195 *   SYNOPSIS
 196 *       value = ReadEEPROMBit(unit)
 197 *
 198 *       BOOL ReadEEPROMBit(struct DevUnit *);
 199 *
 200 *   INPUTS
 201 *       unit - A unit of this device.
 202 *
 203 *   RESULT
 204 *       value - True for one, false for zero.
 205 *
 206 ****************************************************************************
 207 *
 208 */
 209
 210 static BOOL ReadEEPROMBit(struct DevUnit *unit, struct DevBase *base)
 211 {
 212    BOOL is_one;
 213
 214    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM,
 215       R8180ECMD_PROGRAM | R8180REG_EEPROMF_SELECT | R8180REG_EEPROMF_CLK);
 216    BusyMicroDelay(2, base);
 217    is_one =
 218       (unit->ByteIn(unit->card, 0x100 + R8180REG_EEPROM)
 219       & R8180REG_EEPROMF_DATAIN) != 0;
 220    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM,
 221       R8180ECMD_PROGRAM | R8180REG_EEPROMF_SELECT);
 222    BusyMicroDelay(2, base);
 223
 224    return is_one;
 225 }
 226
 227
 228
 229 /****i* realtek8180.device/WriteEEPROMBit **********************************
 230 *
 231 *   NAME
 232 *       WriteEEPROMBit -- Write a bit to the EEPROM.
 233 *
 234 *   SYNOPSIS
 235 *       data_in = WriteEEPROMBit(unit, is_one)
 236 *
 237 *       BOOL WriteEEPROMBit(struct DevUnit *, BOOL);
 238 *
 239 *   INPUTS
 240 *       unit - A unit of this device.
 241 *       is_one - True if a set bit should be written.
 242 *
 243 *   RESULT
 244 *       data_in - True if data-in bit is set.
 245 *
 246 ****************************************************************************
 247 *
 248 */
 249
 250 static BOOL WriteEEPROMBit(struct DevUnit *unit, BOOL is_one,
 251    struct DevBase *base)
 252 {
 253    UWORD data_out;
 254
 255    if(is_one)
 256       data_out = R8180REG_EEPROMF_DATAOUT;
 257    else
 258       data_out = 0;
 259
 260    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM,
 261       R8180ECMD_PROGRAM | R8180REG_EEPROMF_SELECT | data_out);
 262    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM, R8180ECMD_PROGRAM
 263       | R8180REG_EEPROMF_SELECT | R8180REG_EEPROMF_CLK | data_out);
 264    BusyMicroDelay(2, base);
 265    unit->ByteOut(unit->card, 0x100 + R8180REG_EEPROM,
 266       R8180ECMD_PROGRAM | R8180REG_EEPROMF_SELECT | data_out);
 267    BusyMicroDelay(2, base);
 268
 269    return (unit->ByteIn(unit->card, 0x100 + R8180REG_EEPROM)
 270       & R8180REG_EEPROMF_DATAIN) != 0;
 271 }
 272
 273
 274