Customizing CCS Installation

From Texas Instruments Wiki
Jump to: navigation, search

Overview

This topic will show how you can add your own supplemental installers to the CCS installation and have them be automatically installed. This capability is most commonly used by people creating development bundles that include CCS. By using this feature you can have CCS automatically install additional examples, documentation or drivers that are needed for the development kit.

Customizing CCS Installation supports both Windows and Linux platforms. It provides two ways to launch supplemental installers.

CCS Compatible Installer

If you have an InstallJammer installer built according to TI Code Composer Studio component installer specifications, the main CCS installer will pass /y and /prefix options, and the base directory information to the custom installer. The user will be asked to confirm install destination for each of the supplemental installers. This method is only used by a few closely integrated TI 3rd party partners.

Any executable Installer

In order to install a custom installer that does not follow the TI Code Composer Studio component installer specifications, you need a custom script for each operating system with a .bat or .sh extension, which will run the installer. The CCS installer exports the following environment variables, which can be used in custom install scripts.

EXTRASDIR:The extras folder on the same level as the CCS installer.

INSTDIR: The install location for CCS. This is the install directory chosen by the user, with ccsv<version> appended. e.g. /opt/ti/ccsv5. 

ISACMD: The ISA command options to be turned off (i.e /noc2400 /noc2800 /noc5400 /noc5500 /noc6000 /noarm /npomap /nousb /nopp etc).
Please note, this can also be used to turn off documentation by using the option /nodoc.

UPDATENAME: It is the value passed to /updatename option [for update only]

ECLIPSEDIR: Location where eclipse is installed. For CCS 5.0 and up only.

CCS_BASE: The CCS base directory name where Simulation, Emulation, and Debug Server are installed. For CCS 5.0 and up only. e.g. ccs_base_5.0.2.00015
Note: In order to get the full path to ccs_base, you will need to combine INSTDIR and CCS_BASE e.g. %INSTDIR%\%CCS_BASE% or ${INSTDIR}/${CCS_BASE}

Supplemental Installer Source

In order to setup custom installation, create an "extras" folder on the same level as the CCS installer and the "install_images" folder.

Supplemental installers created according to CCS component installer specifications, and requiring no additional parameters other than those described above, have to be stored in the "extras" folder.

Supplemental installers not created according to CCS component installer specifications must be stored in a subfolder of the "extras" folder. You must provide a script with a .bat or .sh extension to run the installer. The custom script must be stored in the "extras" folder.

Any installers requiring a script to be installed have to be stored in a subfolder of the "extras" folder. The custom script that runs the installer must be stored in the "extras" folder.

Please ensure that execute permissions are set correctly on all scripts and installers in the "extras" folder.

Structure of the "extras" folder

| setup_CCS_4.n.n.nnnnn.exe
|
+---extras
|     |     run1.bat
|     |     run2.sh
|     |     IJcompatible-installer1.exe
|     |     IJcompatible-installer2.bin
|     |
|     +---sub1
|     |     installer1.exe
|     \---sub2
|           installer2.bin

|
\---install_images
|     package.properties
|     README_FIRST.txt
+---bios
+---ccscore
+---cgt
+---emulation
+---jre
+---msp430
+---msvc
+---simulation
+---xdais
\---xdctools

Writing Custom Install Scripts

Sample Custom CCS Installation Commands

Windows batch file:

@echo off
rem -- Refer to http://processors.wiki.ti.com/index.php/Customizing_CCS_Installation for full details on how to use this folder.
rem
rem
rem -- The main installer will pass the following arguments to component installer as environment variables
rem -- EXTRASDIR: The extras folder on the same level as the CCS installer.
rem -- Please note, in case the extras folder is on read-only media (e.g. DVD), the main installer will make a copy of it to %TEMP%. This copy will be deleted after the installation is complete.
rem -- INSTDIR: The install location for CCS. This is the install directory chosen by the user, with ccsv<version> appended. e.g. c:\program files\TI\ccsv5.
rem -- ISACMD: The ISA command options to be turned off (i.e /noc2400 /noc2800 /noc5400 /noc5500 /noc6000 /noarm /npomap /nousb /nopp etc).
rem -- Please note, this can also be used to turn off documentation by using the option /nodoc.
rem -- UPDATENAME: It is the value passed to /updatename option [for update only]
rem -- ECLIPSEDIR: Location where eclipse is installed. For CCS 5.0 and up only.
rem -- CCS_BASE: The CCS base directory name where Simulation, Emulation, and Debug Server are installed. For CCS 5.0 and up only. e.g. ccs_base_5.0.2.00015

rem -- Samples of install command with IDE installer
rem -- Please put your batch file(s), *.bat, under {your unzipped CCS folder}\extras\, and put your installer(s), *.exe, in a subfolder. e.g. extras\ide

rem -- if installer supports ISA installation
%EXTRASDIR%\ide\idecore_setup_5.0.0.0.exe /y /prefix %INSTDIR% %ISACMD%

rem -- if installer does not support ISA use one of commands below.
rem -- standard mode install
%EXTRASDIR%\ide\idecore_setup_5.0.0.0.exe /y /prefix %INSTDIR%

rem -- debug mode install
%EXTRASDIR%\ide\idecore_setup_5.0.0.0.exe /debugconsole /prefix %INSTDIR%/inst-extra/

rem -- update install
%EXTRASDIR%\ide\idecore_setup_5.0.0.0.exe /mode default /updatename %UPDATENAME% /prefix %INSTDIR%/eclipse/

rem -- Eclipse binary location - Only for 5.0 and up.
%EXTRASDIR%\ide\idecore_setup_5.0.0.0.exe /mode default /prefix %INSTDIR% /prefix2 %ECLIPSEDIR%

rem -- Base install location for Simulation, Emulation, and Debug Server - Only for 5.0 and up.
%EXTRASDIR%\emulation\emulation_setup_5.0.0.0.exe /mode default /prefix %CCS_BASE% /prefix2 %ECLIPSEDIR%

Linux Shell Script:

#!/bin/sh
# Refer to http://processors.wiki.ti.com/index.php/Customizing_CCS_Installation for full details on how to use this folder.
  1. The main installer will pass the following arguments to component installer as environment variables
    # EXTRASDIR: The extras folder on the same level as the CCS installer.
    # INSTDIR: The install location for CCS. This is the install directory chosen by the user, with ccsv<version> appended. e.g. /opt/ti/ccsv5.
    # ISACMD: The ISA command options to be turned off (i.e /noc2400 /noc2800 /noc5400 /noc5500 /noc6000 /noarm /npomap /nousb /nopp etc).
    # Please note, this can also be used to turn off documentation by using the option /nodoc.
    # UPDATENAME: It is the value passed to /updatename option [for update only]
    # ECLIPSEDIR: Location where eclipse is installed. For CCS 5.0 and up only.
    # CCS_BASE: The CCS base directory name where Simulation, Emulation, and Debug Server are installed. For CCS 5.0 and up only. e.g. ccs_base_5.0.2.00015
  1. Samples of install command with IDE installer
    # Please put your script(s), *.sh, under {your untarred CCS folder}/extras/, and put your installer(s), *.bin, in a subfolder. e.g. extras/ide
  1. if installer supports ISA installation
    ${EXTRASDIR}/ide/idecore_setup_4.1.0.N200911030900.bin /y /prefix ${INSTDIR} $ISACMD
  1. if installer does not support ISA use one of commands below.
    # standard mode install
    ${EXTRASDIR}/ide/idecore_setup_4.1.0.N200911030900.bin /y /prefix ${INSTDIR}
  1. debug mode install
    ${EXTRASDIR}/ide/idecore_setup_4.1.0.N200911030900.bin /debugconsole /prefix ${INSTDIR}/inst-extra/
  1. update install
    ${EXTRASDIR}/ide/idecore_setup_4.1.0.N200911030900.bin /mode default /updatename ${UPDATENAME} /prefix ${INSTDIR}/eclipse/
  1. Eclipse binary location - Only for 5.0 and up.
    ${EXTRASDIR}/ide/idecore_setup_4.1.0.N200911030900.bin /mode default /prefix ${INSTDIR} /prefix2 ${ECLIPSEDIR}
  1. Base install location for Simulation, Emulation, and Debug Server - Only for 5.0 and up.
    ${EXTRASDIR}/emulation/emulation_setup_5.0.0.0.bin /mode default /prefix ${CCS_BASE} /prefix2 ${ECLIPSEDIR}


The script templates are just a reference. Users have full flexibility to write their own custom install scripts.

For example, the following command will install a tar file to the specified location on Linux.

tar -xvzf "$EXTRASDIR"/installer.tar.gz -C "${INSTDIR}/{some where}"

Using Customizing CCS Installation

Custom installations will start after all CCS install actions are complete and before you see the "CCS Installation Complete" pane.

Usage of Extras Install 01.png

CCS Compatible Installer

For InstallJammer installers that are built according to TI Code Composer Studio component installer specifications, with .exe or .bin extension, the main CCS installer will pass /y and /prefix options, and the base directory information to the custom installer. The user will be asked to confirm the install destination for each of the supplemental installers.

Usage of Extras Install 02.png

Any executable Installer

For installers that are not built according to TI Code Composer Studio component installer specifications, the CCS installer will run the custom install scripts.

After custom installs are completed, the user will see the "CCS Installation Complete" pane.

Usage of Extras Install 06.png

Note: If the CCS installer is run in a non-standard mode, CCS installation would still install supplemental installers, but the user would not see any message boxes, or GUI windows.