Page History

Template Revision 2.9

• Module: TRM Name always "TE Series Name" +TRM
  Example: "TE0728 TRM"
• Carrier: TRM Name usually "TEB Series Name" +TRM
  Example: "TEB0728 TRM"

<!-- tables have all same width (web max 1200px and pdf full page(640px), flexible width or fix width on menu for single column can be used as before) -->
<style>
.wrapped{
  width: 100% !important;
  max-width: 1200px !important;
 }
</style>

Important General Note:

• If some section is configurable and depends on Firmware, please refer to the addition page (for example CPLD). If not available, add note, that this part is configurable

• Designate all graphics and pictures with a number and a description, Use "Scroll Title" macro

  • Use "Scroll Title" macro for pictures and table labels. Figure number must be set manually at the moment (automatically enumeration is planned by scrollPDF)

    • Figure template:

      Scroll Title
      anchor Figure_anchorname title Text
      Scroll Ignore Create DrawIO object here: Attention if you copy from other page, objects are only linked. Scroll Only image link to the generate DrawIO PNG file of this page. This is a workaround until scroll pdf export bug is fixed

      
      

    • Table template:

      • Layout macro can be use for landscape of large tables

    • 
      

      Scroll Title
      anchor Table_tablename title Text
      Scroll Table Layout orientation portrait sortDirection ASC repeatTableHeaders default style widths sortByColumn 1 sortEnabled false cellHighlighting true Example Comment 1 2

      
      

  • The anchors of the Scroll Title should be named consistant across TRMs. A incomplete list of examples is given below

    • <type>_<main section>_<name>

      • type: Figure, Table
      • main section:
        
        • "OV" for Overview
        • "SIP" for Signal Interfaces and Pins,
        • "OBP" for On board Peripherals,
        • "PWR" for Power and Power-On Sequence,
        • "B2B" for Board to Board Connector,
        • "TS" for Technical Specification
        • "VCP" for Variants Currently in Production
        •  "RH" for Revision History
      • name: custom, some fix names, see below
    • Fix names:
      

      • "Figure_OV_BD" for Block Diagram

      • "Figure_OV_MC" for Main Components

      • "Table_OV_IDS" for Initial Delivery State

      • "Table_PWR_PC" for Power Consumption

      • "Figure_PWR_PD" for Power Distribution
      • "Figure_PWR_PS" for Power Sequence
      • "Figure_PWR_PM" for Power Monitoring
      • "Table_PWR_PR" for Power Rails
      • "Table_PWR_BV" for Bank Voltages

      • "Table_TS_AMR" for Absolute_Maximum_Ratings

      • "Table_TS_ROC" for Recommended_Operating_Conditions

      • "Figure_TS_PD" for Physical_Dimensions
      • "Table_VCP_SO" for TE_Shop_Overview

      • "Table_RH_HRH" for Hardware_Revision_History

      • "Figure_RH_HRN" for Hardware_Revision_Number
      • "Table_RH_DCH" for Document_Change_History
  • Use Anchor in the document: add link macro and add "#<anchorname>
  • Refer to Anchror from external : <page url>#<pagename without space characters>-<anchorname>

-----------------------------------------------------------------------

Note for Download Link of the Scroll ignore macro:

• Link to the base folder of the module (remove de/ or en/ from the URL):
  Example: https://shop.trenz-electronic.de/Download/?path=Trenz_Electronic/Modules_and_Module_Carriers/4x5_Carriers/TE0728/

Download PDF version of this document.

Table of Contents

Notes :

• short description of the PCB

• Short Link of the wiki resources reference:

  • Use short link the Wiki Resource page, for example: http://trenz.org/te0728-info

  • List of available short links: https://wiki.trenz-electronic.de/display/CON/Redirects

Note:
 'Key Features' description: Important components and connector or other Features of the module
→ please sort and indicate assembly options

add drawIO object here.

Notes :

• Picture of the PCB (top and bottom side) with labels of important components
• Add List below

Notes :

Only components like EEPROM, QSPI flash and DDR3 can be initialized by default at manufacture.

If there is no components which might have initial data ( possible on carrier) you must keep the table empty

• Overview of Boot Mode, Reset, Enables.

Notes :

• For carrier or stand-alone boards use subsection for every connector type (add Designator on description, not on the subsection title), for example:
  • SD
  • USB
  • ETH
  • FMC
  • ...
• For modules which needs carrier use only classes and refer to B2B connector if more than one is used, for example
  
  • JTAG
  • UART
  • I2C
  • MGT
  • ...

Notes :

• add subsection for every component which is important for design, for example:
  • Two 100 Mbit Ethernet Transciever PHY
  • USB PHY
  • Programmable Clock Generator
  • Oscillators
  • eMMCs
  • RTC
  • FTDI
  • ...
  • DIP-Switches
  • Buttons
  • LEDs

Notes :

In the on-board peripheral table "chip/Interface" must be linked to the corresponding chapter or subsection

In 'Power and Power-on Sequence' section there are three important digrams which must be drawn:

• Power on-sequence
• Power distribution
• Voltage monitoring circuit

• This section is optional and only for modules.

• use "include page" macro and link to the general B2B connector page of the module series,

  For example: 6 x 6 SoM LSHM B2B Connectors
  

  Include Page
  6 x 6 SoM LSHM B2B Connectors 6 x 6 SoM LSHM B2B Connectors

In 'Physical Dimension' section, top and bottom view of module must be inserted, information regarding physical dimensions can be obtained through webpage for product in Shop.Trenz, (Download> Documents> Assembly part) for every SoM.

For Example: for Module TE0728, Physical Dimension information can be captured by snipping tools from the link below:

https://www.trenz-electronic.de/fileadmin/docs/Trenz_Electronic/Modules_and_Module_Carriers/5.2x7.6/TE0745/REV02/Documents/AD-TE0745-02-30-1I.PDF

Set correct link to the shop page overview table of the product on English and German.

Example for TE0728:

    ENG Page: https://shop.trenz-electronic.de/en/Products/Trenz-Electronic/TE07XX-Zynq-SoC/TE0728-Zynq-SoC/

    DEU Page: https://shop.trenz-electronic.de/de/Produkte/Trenz-Electronic/TE07XX-Zynq-SoC/TE0728-Zynq-SoC/

For Baseboards or modules, where no overview page is available (and revision number is coded in the direct link) use shop search link, e.g. TE0706:

    ENG Page: https://shop.trenz-electronic.de/en/search?sSearch=TE0706

   DEU Page: https://shop.trenz-electronic.de/de/search?sSearch=TE0706

Set correct links to download  arrier, e.g. TE0706 REV02:

  TE0706-02  ->   https://shop.trenz-electronic.de/Download/?path=Trenz_Electronic/Modules_and_Module_Carriers/4x5/4x5_Carriers/TE0706/REV02/Documents

• Note this list must be only updated, if the document is online on public doc!
• It's semi automatically, so do following
  

  • Add new row below first

  • Copy "Page Information Macro(date)" Macro-Preview, Metadata Version number, Author Name and description to the empty row. Important Revision number must be the same as the Wiki document revision number Update Metadata = "Page Information Macro (current-version)" Preview+1 and add Author and change description. --> this point is will be deleted on newer pdf export template

  • Metadata is only used of compatibility of older exports