Zerocat Chipflasher  v0.4.10-182-333b622f
Flash free firmware to BIOS chips, kick the Management Engine.
doc/files.dox File Reference

Doxygen File Documentations. More...

Detailed Description

Code

/**
  @file

  @brief Doxygen File Documentations

  # Code

  @verbinclude doc/files.dox

  # “In file” Documentation

**/

/**
  @file doc/frontpage.md

  @brief Frontpage for the – to be generated – documentation.

  Documentation source file in markdown syntax, used as the frontpage (aka “Main Page”) for the – to
  be generated – documentation. This file references the @ref README.md along with other,
  categorized documentation files. It should not be skipped when reading the documentation, as it
  provides a valuable overview.

**/

/**
  @file ../doc/Makefile

  # Code

  @verbinclude doc/Makefile

**/

/**
  @file ../host/start/Makefile

  # Code

  @verbinclude host/start/Makefile

**/

/**
  @file ../firmware/src/Makefile

  # Code

  @verbinclude firmware/src/Makefile

**/

/**
  @file ../hardware/Makefile

  # Code

  @verbinclude hardware/Makefile

**/

/**
  @file ../doc/doxygen-resources/Doxyfile.orig

  @brief Project’s configuration file for Doxygen.

  # Notes

  INPUT

  Order matters!

  FILTER_PATTERNS

  Is not supported with Doxygen 1.8.6, use INPUT_FILTER instead.
  Is not fully supported with Doxygen 1.8.15 (doesn't match Makefile), use INPUT_FILTER instead.

  EXTENSION_MAPPING, INPUT_FILTER

  For some special file extensions, doxygen is forced to use the C-parser as no other appropriate
  parser is available: Make files, shell scripts and gschem scheme files. These files should carry
  special comment markers (i.e. `##>` or `;;>`), which will be transformed into C-style comments
  (`//`) before being parsed. The bash-bang of shell scripts (i.e. `#!/bin/bash`) will be prefixed with
  `//`. The code of these files must be excluded from parsing by means of \@cond..\@endcond
  directives. This filter technique allows placement of doxygen documentation within these files,
  as for instance:

      ##>! [at]file
      ##>!
      ##>! [at]brief Short file desciption.
      ##>!
      ##>! Some file documentation with more doxygen tags.
      ##>!
      ##>! [at]cond
      # --- This one line will be issued by doxygen during the make of the documentation ---
      ...
      code
      ...
      ##>! [at]endcond

  IMAGE_PATH

  This applies only if the image in embedded, not if it is just linked!
  Note that relative paths are not really supported and there are
  constraints for nice locations of image folders.

  REFERENCED_BY_RELATION

  This works fine with doxygen 1.8.6, but doxygen 1.8.15 doesn’t list references for macros.

  # Code

  @verbinclude doc/doxygen-resources/Doxyfile.orig

**/

/**
  @file ../host/src/Makefile

  # Documentation

  Please compare to:

    https://www.gnu.org/software/make/manual/make.html#Simple-Makefile

  # Code

  @verbinclude host/src/Makefile

**/

/**
  @file ../host/src/connect.c

  @brief Principle source file of the chipflasher’s host utility `connect`.

**/

/**
  @file ../host/src/connect.h

  @brief Declaration header for the @ref host/src/connect.c source file.

**/

/**
  @file ../host/src/ANSI-color-escape-sequences.h

  @brief ANSI and VT100 Escape Sequences.

  # Usage

      printf("simple" SET_BOLD FG_YELLOW "bold" RESET_ALL "\r\n");

**/

/**
  @file ../hardware/gschem/board-to-image.scm

  # Code

  @verbinclude hardware/gschem/board-to-image.scm

**/

/**
  @file ../hardware/gschem/rules-drc.scm

  # Code

  @verbinclude hardware/gschem/rules-drc.scm

**/

/**
  @file ../firmware/start/board.cfg

  # Code

  @verbinclude firmware/start/board.cfg

**/

/**
  @file firmware/start/Makefile

  # Code

  @verbinclude firmware/start/Makefile

**/

/**
  @file hardware/gschem/attribs

  @brief List of attributes to use for `gnetlist`’s `bom2` backend.

  # Documentation

  Bill-of-Material (BoM) files are generated from circuit schematics via `gnetlist -gbom2`, which
  in turn looks for a file called `attribs` to know about which device attributes should be
  extracted. See @ref hardware/Makefile.

  # Code

  @verbinclude hardware/gschem/attribs

**/

/**
  @file hardware/pcb/board.pcb

  @brief PCB source file of the chipflasher board.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

  # Code

  @verbinclude hardware/pcb/board.pcb

**/

/**
  @file hardware/pcb/footprints/ACY100S

  @brief PCB source file.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

  # Code

  @verbinclude hardware/pcb/footprints/ACY100S

**/

/**
  @file hardware/pcb/footprints/Trim-Resistor-500

  @brief PCB source file.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

  # Code

  @verbinclude hardware/pcb/footprints/Trim-Resistor-500

**/

/**
  @file hardware/pcb/footprints/USB-Type-A-Connector

  @brief PCB source file.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

  # Code

  @verbinclude hardware/pcb/footprints/USB-Type-A-Connector

**/

/**
  @file hardware/librecad/front-panel.dxf

  @brief Front panel outline for the chipflasher device, with drillings.

  # Info

  Librecad DXF vector graphics with outline and drillings.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

**/

/**
  @file hardware/artwork/front-label.svg

  @brief Front panel sticker for the chipflasher device, Inkscape SVG vector graphics.

  # Copyright

  Zerocat Chipflasher --- Flash free firmware to BIOS chips,
                          kick the Management Engine.

  Copyright (C) 2017, 2018 Kai Mertens <kmx@posteo.net>

  The Zerocat Chipflasher is free software: you can redistribute it
  and/or modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation, either version 3 of
  the License, or (at your option) any later version.

  The Zerocat Chipflasher is distributed in the hope that it will be
  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see <http://www.gnu.org/licenses/>.

  This file is part of the Zerocat Chipflasher.

**/

/**
  @file hardware/gschem/board-dev.sch

  @brief gEDA/gschem circuit schematic of the chipflasher development board.

**/

/**
  @file hardware/gschem/board.sch

  @brief gEDA/gschem circuit schematic of the chipflasher board.

**/

/**
  @file hardware/gschem/cables.sch

  @brief gEDA/gschem circuit schematic of cable accessories.

**/

/**
  @file hardware/gschem/P8X32A-1.sym

  @brief gEDA/gschem schematic symbol of the Parallax Propeller-1 microcontroller (DIL40).

**/

/**
  @file hardware/gschem/IRLML6402-1.sym

  @brief gEDA/gschem schematic symbol of the IRLML6402 MOSFET.

**/

/**
  @file hardware/gschem/AMS1117-1.sym

  @brief gEDA/gschem schematic symbol of the AMS1117 power regulator.

**/

/**
  @file hardware/gschem/AT26DF321-1.sym

  @brief gEDA/gschem schematic symbol of the AT26DF321 8pin SOIC SPI flash chip.

**/

/**
  @file hardware/gschem/MX25L1605D-1.sym

  @brief gEDA/gschem schematic symbol of the MX25L1605D 8pin SOIC SPI flash chip.

**/

/**
  @file hardware/gschem/MX25L6405D-1.sym

  @brief gEDA/gschem schematic symbol of the MX25L6405D 16pin SOIC SPI flash chip.

**/

/**
  @file hardware/gschem/SST25VF016B-1.sym

  @brief gEDA/gschem schematic symbol of the SST25VF016B 8pin SOIC SPI flash chip.

**/

/**
  @file firmware/src/libcommon/filespec.h

  @brief Declaration header for the @ref firmware/src/libcommon/filespec.c source file.

**/

/**
  @file firmware/src/libprop/putChar.h

  @brief Declaration header for the @ref firmware/src/libprop/putChar.c source file.

**/

/**
  @file firmware/src/kick.h

  @brief Declaration header for the @ref firmware/src/kick.c source file.

**/

/**
  @file firmware/src/libkick/chipspec.h

  @brief Declaration header for the @ref firmware/src/libkick/chipspec.c source file.

**/

/**
  @file firmware/src/libkick/chipspec.c

  @brief Selected chips, commonly found on targeted hardware, described according to their datasheets.

**/

/**
  @file firmware/src/libcommon/common.h

  @brief Declaration header for @ref host/src/connect.c and @ref firmware/src/kick.c source files.

**/

/**
  @file firmware/src/libcommon/serial-codes.h

  @brief
  Declaration header for the @ref host/src/connect.c and @ref firmware/src/kick.c source files.
  Also used by @ref host/src/connect.h.

**/

/**
  @file host/util/manifest.scm

  @brief Project’s Package Manifest for GNU Guix System.

  @verbinclude host/util/manifest.scm

**/

“In file” Documentation