doc/README.PIP405

   1 U-Boot Changes due to PIP405 Port:
   2 ===================================
   3
   4 Changed files:
   5 ==============
   6 - MAKEALL                       added PIP405
   7 - makefile                      added PIP405
   8 - common/Makefile               added Floppy disk and SCSI support
   9 - common/board.c                added PIP405, SCSI support, get_PCI_freq()
  10 - common/bootm.c                added IH_OS_U_BOOT, IH_TYPE_FIRMWARE
  11 - common/cmd_i2c.c              added "defined(CONFIG_PIP405)"
  12 - common/cmd_ide.c              changed div. functions to work with block device
  13                                 description
  14                                 added ATAPI support
  15 - common/command.c              added SCSI and Floppy support
  16 - common/console.c              replaced // with /* comments
  17                                 added console settings from environment
  18 - common/devices.c              added ISA keyboard init
  19 - common/main.c                 corrected the read of bootdelay
  20 - cpu/ppc4xx/405gp_pci.c        excluded file from PIP405
  21 - cpu/ppc4xx/i2c.c              added 16bit read write I2C support
  22                                 added page write
  23 - cpu/ppc4xx/speed.c            added get_PCI_freq
  24 - cpu/ppc4xx/start.S            added CONFIG_IDENT_STRING
  25 - disk/Makefile                 added part_iso for CD support
  26 - disk/part.c                   changed to work with block device description
  27                                 added ISO CD support
  28                                 added dev_print (was ide_print in cmd_ide.c)
  29 - disk/part_dos.c               changed to work with block device description
  30 - disk/part_mac.c               changed to work with block device description
  31 - include/ata.h                 added ATAPI commands
  32 - include/cmd_bsp.h             added PIP405 commands definitions
  33 - include/cmd_condefs.h         added Floppy and SCSI support
  34 - include/cmd_disk.h            changed to work with block device description
  35 - include/config_LANTEC.h       excluded CONFIG_CMD_FDC and CONFIG_CMD_SCSI
  36 - include/config_hymod.h        excluded CONFIG_CMD_FDC and CONFIG_CMD_SCSI
  37 - include/flash.h               added INTEL_ID_28F320C3T  0x88C488C4
  38 - include/i2c.h                 added "defined(CONFIG_PIP405)"
  39 - include/image.h               added IH_OS_U_BOOT, IH_TYPE_FIRMWARE
  40 - include/u-boot.h              moved partitions functions definitions to part.h
  41                                 added "defined(CONFIG_PIP405)"
  42                                 added get_PCI_freq() definition
  43 - rtc/Makefile                  added MC146818 RTC support
  44 - tools/mkimage.c               added IH_OS_U_BOOT, IH_TYPE_FIRMWARE
  45
  46 Added files:
  47 ============
  48 - board/pip405                  directory for PIP405
  49 - board/pip405/cmd_pip405.c     board specific commands
  50 - board/pip405/config.mk        config make
  51 - board/pip405/flash.c          flash support
  52 - board/pip405/init.s           start-up
  53 - board/pip405/kbd.c            keyboard support
  54 - board/pip405/kbd.h            keyboard support
  55 - board/pip405/Makefile         Makefile
  56 - board/pip405/pci_piix4.h      southbridge definitions
  57 - board/pip405/pci_pip405.c     PCI support for PIP405
  58 - board/pip405/pci_pip405.h     PCI support for PIP405
  59 - board/pip405/pip405.c         PIP405 board init
  60 - board/pip405/pip405.h         PIP405 board init
  61 - board/pip405/pip405_isa.c     ISA support
  62 - board/pip405/pip405_isa.h     ISA support
  63 - board/pip405/u-boot.lds       Linker description
  64 - board/pip405/u-boot.lds.debugLinker description debug
  65 - board/pip405/sym53c8xx.c      SYM53C810A support
  66 - board/pip405/sym53c8xx_defs.h SYM53C810A definitions
  67 - board/pip405/vga_table.h      definitions of tables for VGA
  68 - board/pip405/video.c          CT69000 support
  69 - board/pip405/video.h          CT69000 support
  70 - common/cmd_fdc.c              Floppy disk support
  71 - common/cmd_scsi.c             SCSI support
  72 - disk/part_iso.c               ISO CD ROM support
  73 - disk/part_iso.h               ISO CD ROM support
  74 - include/cmd_fdc.h             command forFloppy disk support
  75 - include/cmd_scsi.h            command for SCSI support
  76 - include/part.h                partitions functions definitions
  77                                 (was part of u-boot.h)
  78 - include/scsi.h                SCSI support
  79 - rtc/mc146818.c                MC146818 RTC support
  80
  81
  82 New Config Switches:
  83 ====================
  84 For detailed description, refer to the corresponding paragraph in the
  85 section "Changes".
  86
  87 New Commands:
  88 -------------
  89 CONFIG_CMD_SCSI SCSI Support
  90 CONFIG_CMF_FDC  Floppy disk support
  91
  92 IDE additions:
  93 --------------
  94 CONFIG_IDE_RESET_ROUTINE        defines that instead of a reset Pin,
  95                                 the routine ide_set_reset(int idereset) is used.
  96 ATAPI support (experimental)
  97 ----------------------------
  98 CONFIG_ATAPI    enables ATAPI Support
  99
 100 SCSI support (experimental) only SYM53C8xx supported
 101 ----------------------------------------------------
 102 CONFIG_SCSI_SYM53C8XX           type of SCSI controller
 103 CFG_SCSI_MAX_LUN        8       number of supported LUNs
 104 CFG_SCSI_MAX_SCSI_ID    7       maximum SCSI ID (0..6)
 105 CFG_SCSI_MAX_DEVICE     CFG_SCSI_MAX_SCSI_ID * CFG_SCSI_MAX_LUN
 106                                 maximum of Target devices (multiple LUN support
 107                                 for boot)
 108
 109 ISO (CD-Boot) partition support (Experimental)
 110 ----------------------------------------------
 111 CONFIG_ISO_PARTITION            CD-boot support
 112
 113 RTC
 114 ----
 115 CONFIG_RTC_MC146818             MC146818 RTC support
 116
 117 Keyboard:
 118 ---------
 119 CONFIG_ISA_KEYBOARD             Standard (PC-Style) Keyboard support
 120
 121 Video:
 122 ------
 123 CONFIG_VIDEO_CT69000            Enable Chips & Technologies 69000 Video chip
 124                                 CONFIG_VIDEO must be defined also
 125
 126 External peripheral base address:
 127 ---------------------------------
 128 CFG_ISA_IO_BASE_ADDRESS         address of all ISA-bus related parts
 129                                 _must_ be defined for ISA-bus parts
 130
 131 Identify:
 132 ---------
 133 CONFIG_IDENT_STRING             added to the U_BOOT_VERSION String
 134
 135
 136 I2C stuff:
 137 ----------
 138 CFG_EEPROM_PAGE_WRITE_ENABLE    enables page write of the I2C EEPROM
 139                                 CFG_EEPROM_PAGE_WRITE_BITS _must_ be
 140                                 defined.
 141
 142
 143 Environment / Console:
 144 ----------------------
 145
 146 CFG_CONSOLE_IS_IN_ENV           if defined, stdin, stdout and stderr used from
 147                                 the values stored in the evironment.
 148
 149 CFG_CONSOLE_OVERWRITE_ROUTINE   if defined, console_overwrite() decides if the
 150                                 values stored in the environment or the standard
 151                                 serial in/out put should be assigned to the console.
 152
 153 CFG_CONSOLE_ENV_OVERWRITE       if defined, the start-up console switching
 154                                 are stored in the environment.
 155
 156 PIP405 specific:
 157 ----------------
 158 CONFIG_PORT_ADDR                address used to read boot configuration
 159 MULTI_PURPOSE_SOCKET_ADDR       address of the multi purpose socked
 160 SDRAM_EEPROM_WRITE_ADDRESS      addresses of the serial presence detect
 161 SDRAM_EEPROM_READ_ADDRESS       EEPROM on the SDRAM module.
 162
 163
 164 Changes:
 165 ========
 166
 167 Added Devices:
 168 ==============
 169
 170 Floppy support:
 171 ---------------
 172 Support of a standard floppy disk controller at address CFG_ISA_IO_BASE_ADDRESS
 173 + 0x3F0. Enabled with define CONFIG_CMD_FDC. Reads a unformated floppy disk
 174 with a image header (see: mkimage). No interrupts and no DMA are used for this.
 175 Added files:
 176 - common/cmd_fdc.c
 177 - include/cmd_fdc.h
 178
 179 SCSI support:
 180 -------------
 181 Support for Symbios SYM53C810A chip. Implemented as follows:
 182 - without disconnect
 183 - only asynchrounous
 184 - multiple LUN support (caution, needs a lot of RAM. define CFG_SCSI_MAX_LUN 1 to
 185   save RAM)
 186 - multiple SCSI ID support
 187 - no write support
 188 - analyses the MAC, DOS and ISO pratition similar to the IDE support
 189 - allows booting from SCSI devices similar to the IDE support.
 190 The device numbers are not assigned like they are within the IDE support. The first
 191 device found will get the number 0, the next 1 etc. If all SCSI IDs (0..6) and all
 192 LUNs (8) are enabled, 56 boot devices are possible. This uses a lot of RAM since the
 193 device descriptors are not yet dynamically allocated. 56 boot devices are overkill
 194 anyway. Please refer to the section "Todo" chapter "block device support enhancement".
 195 The SYM53C810A uses 1 Interrupt and must be able of mastering the PCI bus.
 196 Added files:
 197 - common/cmd_scsi.c
 198 - common/board.c
 199 - include/cmd_scsi.h
 200 - include/scsi.h
 201 - board/pip405/sym53c8xx.c
 202 - board/pip405/sym53c8xx_defs.h
 203
 204 ATAPI support (IDE changes):
 205 ----------------------------
 206 Added ATAPI support (with CONFIG_ATAPI) in the file cmd_ide.c.
 207 To support a hardreset, when the IDE reset pin is not connected to the
 208 CFG_PC_IDE_RESET pin, the switch CONFIG_IDE_RESET_ROUTINE has been added. When
 209 this switch is enabled the routine void ide_set_reset(int idereset) must be
 210 within the board specific files.
 211 Only read from ATAPI devices are supported.
 212 Found out that the function trim_trail cuts off the last character if the whole
 213 string is filled. Added function cpy_ident instead, which trims also leading
 214 spaces and copies the string in the buffer.
 215 Changed files:
 216 - common/cmd_ide.c
 217 - include/ata.h
 218
 219 ISO partition support:
 220 ----------------------
 221 Added CD boot support for El-Torito bootable ISO CDs. The bootfile image must contain
 222 the U-Boot image header. Since CDs do not have "partitions", the boot partition is 0.
 223 The bootcatalog feature has not been tested so far. CD Boot is supported for ATAPI
 224 ("diskboot") and SCSI ("scsiboot") devices.
 225 Added files:
 226 - disk/iso_part.c
 227 - disk/iso_part.h
 228
 229 Block device changes:
 230 ---------------------
 231 To allow the use of dos_part.c, mac_part.c and iso_part.c, the parameter
 232 block_dev_desc will be used when accessing the functions in these files. The block
 233 device descriptor (block_dev_desc) contains a pointer to the read routine of the
 234 device, which will be used to read blocks from the device.
 235 Renamed function ide_print to dev_print and moved it to the file disk/part.c to use
 236 it for IDE ATAPI and SCSI devices.
 237 Please refer to the section "Todo" chapter "block device support enhancement".
 238 Added files:
 239 - include/part.h
 240 changed files:
 241 - disk/dos_part.c
 242 - disk/dos_part.h
 243 - disk/mac_part.c
 244 - disk/mac_part.h
 245 - disk/part.c
 246 - common/cmd_ide.c
 247 - include/u-boot.h
 248
 249
 250 MC146818 RTC support:
 251 ---------------------
 252 Added support for MC146818 RTC with defining CONFIG_RTC_MC146818. The ISA bus IO
 253 base address must be defined with CFG_ISA_IO_BASE_ADDRESS.
 254 Added files:
 255 - rtc/mc146818.c
 256
 257 Standard ISA bus Keyboard support:
 258 ----------------------------------
 259 Added support for the standard PC kyeboard controller. For the PIP405 the superIO
 260 controller must be set up previously. The keyboard uses the standard ISA IRQ, so
 261 the ISA PIC must also be set up.
 262 Added files:
 263 - board/pip405/kbd.c
 264 - board/pip405/kbd.h
 265 - board/pip405/pip405_isa.c
 266 - board/pip405/pip405_isa.h
 267
 268 Chips and Technologie 69000 VGA controller support:
 269 ---------------------------------------------------
 270 Added support for the CT69000 VGA controller.
 271 Added files:
 272 - board/pip405/video.c
 273 - board/pip405/video.h
 274 - board/pip405/vga_table.h
 275
 276
 277 Changed Items:
 278 ==============
 279
 280 Identify:
 281 ---------
 282 Added the config variable CONFIG_IDENT_STRING which will be added to the
 283 "U_BOOT_VERSION __TIME__ DATE___ " String, to allows to identify intermidiate
 284 and custom versions.
 285 Changed files:
 286 - cpu/ppc4xx/start.s
 287
 288 Firmware Image:
 289 ---------------
 290 Added IH_OS_U_BOOT and IH_TYPE_FIRMWARE to the image definitions to allows the
 291 U-Boot update with prior CRC check.
 292 Changed files:
 293 - include/image.h
 294 - tools/mkimage.c
 295 - common/cmd_bootm.c
 296
 297 Correct PCI Frequency for PPC405:
 298 ---------------------------------
 299 Added function (in cpu/ppc4xx/speed.c) to get the PCI frequency for PPC405 CPU.
 300 The PCI Frequency will now be set correct in the board description in common/board.c.
 301 (was set to the busfreq before).
 302 Changed files:
 303 - cpu/ppc4xx/speed.c
 304 - common/board.c
 305
 306 I2C Stuff:
 307 ----------
 308 Added defined(CONFIG_PIP405) at several points in common/cmd_i2c.c.
 309 Added 16bit read/write support for I2C (PPC405), and page write to
 310 I2C EEPROM if defined CFG_EEPROM_PAGE_WRITE_ENABLE.
 311 Changed files:
 312 - cpu/ppc4xx/i2c.c
 313 - common/cmd_i2c.c
 314
 315 Environment / Console:
 316 ----------------------
 317 Although in README.console described, the U-Boot has not assinged the values
 318 found in the environment to the console. Corrected this behavior, but only if
 319 CFG_CONSOLE_IS_IN_ENV is defined.
 320 If CFG_CONSOLE_OVERWRITE_ROUTINE is defined, console_overwrite() decides if the
 321 values stored in the environment or the standard serial in/output should be
 322 assigned to the console. This is useful if the environment values are not correct.
 323 If CFG_CONSOLE_ENV_OVERWRITE is defined the devices assigned to the console at
 324 start-up time will be written to the environment. This means that if the
 325 environment values are overwritten by the overwrite_console() routine, they will be
 326 stored in the environment.
 327 Changed files:
 328 - common/console.c
 329
 330 Correct bootdelay intepretation:
 331 --------------------------------
 332 Changed bootdelay read from the environment from simple_strtoul (unsigned) to
 333 simple_strtol (signed), to be able to get a bootdelay of -1.
 334 Changed files:
 335 - common/main.c
 336
 337 Todo:
 338 =====
 339
 340 Block device support enhancement:
 341 ---------------------------------
 342 Consider to unify the block device handling. Instead of using diskboot for IDE,
 343 scsiboot for SCSI and fdcboot for floppy disks, it would make sense to use only
 344 one command ("devboot" ???) with a parameter of the desired device ("hda1", "sda1",
 345 "fd0" ???) to boot from. The other ide commands can be handled in the same way
 346 ("dev hda read.." instead of "ide read.." or "dev sda read.." instead of
 347 "scsi read..."). Todo this, a common way of assign a block device to its name
 348 (first found ide device = hda, second found hdb etc., or hda is device 0 on bus 0,
 349 hdb is device 1 on bus 0 etc.) as well as the names (hdx for ide, sdx for scsi, fx for
 350 floppy ???) must be defined.
 351 Maybe there are better ideas to do this.
 352
 353 Console assingment:
 354 -------------------
 355 Consider to initialize and assign the console stdin, stdout and stderr as soon as
 356 possible to see the boot messages also on an other console than serial.
 357
 358
 359 Todo for PIP405:
 360 ================
 361
 362 LCD support for VGA:
 363 --------------------
 364 Add LCD support for the CT69000
 365
 366 Default environment:
 367 --------------------
 368 Consider to write a default environment to the OTP part of the EEPROM and use it
 369 if the normal environment is not valid. Useful for serial# and ethaddr values.
 370
 371 Watchdog:
 372 ---------
 373 Implement Watchdog.
 374
 375 Files clean-up:
 376 ---------------
 377 Following files needs to be cleaned up:
 378 - cmd_pip405.c
 379 - flash.c
 380 - pci_pip405.c
 381 - pip405.c
 382 - pip405_isa.c
 383 Consider to split up the files in their functions.