BSP Platform

"Platform" is an alternative approach to creating BSP variants, previously managed as "Flavors".
See BSP Flavor for the flavors approach to variant development.

Steps to Create a Platform Based on an existing BSP

Create the Platform in the Repository

• Add the new platform name under /scm/Deos/products/platform.
• Create the following directories:
  • branches
  • branches/mainline
  • branches/mainline/code
  • branches/mainline/config
  • branches/mainline/config/etc <-- to store platform-specific configuration files (pia, fp, options, lwip)
  • branches/mainline/common <-- to set up external dependencies
• Add the platform directories to the repository. (svn add)
• Add the following files: (svn copy/modify from another similar platform and/or the parent platform and related drivers)
  • labels.txt
  • branches/mainline/README.txt
  • branches/mainline/configure.ac
  • branches/mainline/release-notes.xml
  • branches/mainline/code/makefile.mk
  • branches/mainline/config/etc/lwip.config
  • branches/mainline/config/etc/openarbor.options
  • branches/mainline/config/etc/?.fp.xml
  • branches/mainline/config/etc/?.pia.xml
• Set the svn:externals for the common directory to include the latest versions of:
  • /scm/Deos/maintainer-tools/build-utils@<version> build-utils
  • /scm/Deos/products/common/reference-xml@<version> reference-xml

Example File Content

Using the niu3c-platform as the example.

• README.txt (list the base BSP aka parent platform as a required install)

# Build & Test Instructions

## Building

install the packages: deos-maintainer-tools nai-ultrascale
See `common/build-utils/Common-Makefile-HowTo.htm#standard-operations`

## Testing

TBD.

• configure.ac

# This is an autoconf file, see
# common/build-utils/Common-Makefile-HowTo.htm for more info.
AC_INIT(niu3c-platform,1.0.0)

# See Common-Makefile-HowTo.htm#changing-interface for build interface migration instructions.
commonBuildSystemInterface=6

xPossibleHosts="arm-deos" 

xPossibleHostVariations="release"

xReleaseDirectory=deos-products/platform/niu3c

# This is needed for the device driver to deliver content from config
xBranchPrefixSubdirs="code config docs"

builtin(include, common/build-utils/deos-rules.ac)
AC_OUTPUT

• makefile.mk

#------------------------------------------------------------------------------
# Sub makefile.  This makefile expects to be included as part of a
# higher level make as described in:
# $(BRANCH_PREFIX)/common/build-utils/Common-Makefile-HowTo.htm
#------------------------------------------------------------------------------

ifeq ($(ENABLE_HOST_MAKE),yes)

CLEAN_FILES += filesInRelease.xml release-notes.dtd

#------------------------------------------------------------------------------
# Use INSTALL_TREE to copy all files under "config" excluding ".svn" and
# makefile.mk into the install DESK tree.
# ------------------------------------------------------------------------------
$(eval $(call INSTALL_TREE,$(DESK_INSTALL_PREFIX)/platform/$(PROJECT_NAME:-platform=),$(BRANCH_PREFIX)/config, .svn makefile.mk))

endif # ENABLE_HOST_MAKE

• release-notes.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE article SYSTEM "release-notes.dtd" [
<!ENTITY bibliography SYSTEM "common/reference-xml/bibliography.bibdb">
<!ENTITY acronyms-table SYSTEM "common/reference-xml/acronyms-table.sgm">
<!ENTITY terms-table SYSTEM "common/reference-xml/terms-table.sgm">
]>

<article role="!ROLE!"
         xmlns="http://docbook.org/ns/docbook" version="5.0"
         xmlns:xi="http://www.w3.org/2001/XInclude"
         xmlns:xl="http://www.w3.org/1999/xlink">

  &articleinfo;

  <section xml:id="disclaimer"><title>Disclaimer</title>
    <para>&designAssuranceLevelE;</para>
    <para>&tradeSecretNotShared;</para>
    <para>&warranty;</para>
  </section> <!-- Disclaimer -->

  <section xml:id="description"><title>Description</title>

    <para>The NIU3C platform package provides the niu3c platform (/desk/platform/niu3c)
    which extends the base nai-ultrascale BSP.</para>

  </section> <!-- Description -->

  <section xml:id="compatibility"><title>Compatibility</title>
    <para>This component depends on the following components:</para>

    <simplelist>
      <member>nai-ultrascale version 6.4.0 or later</member>
      <member>xilinx-gem version 3.4.1 or later</member>
    </simplelist>
  </section>

  <section xml:id="how-to-use"><title>How To Use</title>
    <para>Refer to the <link xl:href="nai-ultrascale-bsp-user-guide.htm">NAI_ULTRASCALE BSP User Guide.</link></para>
  </section> <!-- How To Use -->

  <section xml:id="caveats"><title>Caveats</title>
    <!-- &developmentDistribution; --> <!-- This is distribution is not for customer delivery! -->
    <para>This component extends the nai-ultrascale BSP provided by DDC-I. It 
    cannot be used stand-alone.</para>
  </section> <!-- Caveats -->
  

  <section xml:id="changes"><title>Changes from Previous Releases</title>

    <para>Releases are identified below by version number, and are listed in order of most
    recent release.</para>

    <variablelist>
      <varlistentry>
        <term><token>&component.version; (&component.revision;)</token></term>
        <listitem>
          <itemizedlist>
            <listitem><para>Initial release.</para></listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>

    </variablelist>
  </section> <!-- Changes -->

  <section xml:id="known-problems"><title>Known Problems</title>
    <para>&knownProblemsReference;</para>
  </section> <!-- Known Problems -->

  &filesInRelease;

</article>

<!-- Local Variables: -->
<!-- fill-column: 95 -->
<!-- End: -->

Example Platforms

niu3c-platform