SourcePoint Intel Help
Table of Contents
- Using Help
- Contacting ASSET InterTech
- Introduction to SourcePoint
- SourcePoint Environment
- SourcePoint Overview
- SourcePoint Parent Window Introduction
- SourcePoint Icon Toolbar
- File Menu
- File Menu - Project Menu Item
- File Menu - Layout Menu Item
- File Menu - Program Menu Item
- File Menu - Macro Menu Item
- File Menu - Print Menu Items
- File Menu - Update Emulator Flash Menu Item
- File Menu - Program Target Device Menu Item
- File Menu - Other Menu Items
- Edit Menu
- View Menu
- Processor Menu
- Options Menu
- Options Menu - Preferences Menu Item
- Options Menu - Target Configuration Menu Item
- Options Menu - Load Target Configuration File Menu Item
- Options Menu - Save Target Configuration File Menu Item
- Options Menu - Emulator Configuration Menu Item
- Options Menu - Emulator Connection Menu Item
- Options Menu - Emulator Reset Menu Item
- Options Menu - Confidence Tests Menu Item
- Window Menu
- Help Menu
- How To -- SourcePoint Environment
- Add Emulator Connections
- Configure Custom Macro Icons
- Configure Autoloading Macros
- Display Text on the Icon Toolbar
- Edit Icon Groups to Customize Your Toolbars
- Modify a Defined Memory Region
- Refresh SourcePoint Windows
- Save a Program
- Start SourcePoint With Command Line Arguments
- Use the New Project Wizard
- Verify Emulator Network Connections
- SourcePoint Overview
- Breakpoints Window
- Breakpoints Window Overview
- How To - Breakpoints
- Code Window
- Command Window
- Command Window Overview
- Confidence Tests Window
- Confidence Tests Window Overview
- Descriptors Tables Window
- Descriptors Tables Window Overview
- How To - Descriptors
- Devices Window
- Devices Window Overview
- How To - Devices Window
- Log Window
- Log Window Overview
- Memory Window
- Memory Window Overview
- How To - Memory Window
- Page Translation Window
- Page Translation Windows Overview
- PCI Devices Window
- PCI Devices Window Overview
- How To - PCI Devices Window
- Registers Window
- Registers Window Overview
- How To - Registers
- Symbols Windows
- Symbols Window Overview
- How To - Symbols Window
- Trace Window
- Trace Window Overview
- How To - Trace Window
- Advanced
- Viewpoint Window
- Viewpoint Window Overview
- Watch Window
- Watch Window Overview
- How To - Watch Window
- Technical Notes
- Descriptor Cache: Revealing Hidden Registers
- UEFI Framework Debugging
- Memory Casting
- Microsoft PE Format Support in SourcePoint
- Multi-Clustering
- Python/CScripts
- OpenIPC Integration, Installation and Usage
- Registers Keyword Table
- SourcePoint Licensing
- Stepping
- Symbols Textsym Format
- Target Configuration
- Using Bookmarks
- Which Processor Is Which
- Getting Started with DbC
- SourcePoint Command Language
- Overview
- Commands and Control Variables
- aadump
- abort
- abs
- acos
- advanced
- asin
- asm
- asmmode
- atan
- atan2
- autoconfigure
- base
- bell (beep)
- bits
- break
- breakall
- cachememory
- cause
- Character Functions
- clock
- continue
- cos
- cpubreak commands
- cpuid_eax
- cpuid_ebx
- cpuid_ecx
- cpuid_edx
- createprocess
- cscfg, local_cscfg
- csr
- ctime
- cwd
- dbgbreak commands
- defaultpath
- #define
- define
- definemacro
- deviceconfigure
- devicelist
- devicescan
- disconnect
- displayflag
- do while
- dos
- dport
- drscan
- edit
- editor
- emubreak, emuremove, emudisable, emuenable
- emulatorstate
- encrypt
- error
- eval
- evalprogramsymbol
- execution point ($)
- exit
- exp
- fc
- fclose
- feof
- fgetc
- fgets
- first_jtag_device
- flist
- flush
- fopen
- for
- forward
- fprintf
- fputc
- fputs
- fread
- fseek
- ftell
- fwrite
- getc
- getchar
- getnearestprogramsymbol
- getprogramsymboladdress
- gets
- globalsourcepath
- go
- halt
- help
- homepath
- idcode
- if
- include
- invd
- irscan
- isdebugsymbol
- isem64t
- isprogramsymbol
- isrunning
- issleeping
- issmm
- itpcompatible
- jtagchain
- jtagconfigure
- jtagdeviceadd
- jtagdeviceclear
- jtagdevices
- jtagscan
- jtagtest
- keys
- last
- last_jtag_device
- left
- libcall
- license
- linear
- list, nolist
- load
- loadbreakpoints
- loadlayout
- loadproject
- loadtarget
- loadwatches
- log, nolog
- log10
- loge
- logmessage
- macropath
- Memory Access
- messagebox
- mid
- msgclose
- msgdata
- msgdelete
- msgdr
- msgdump
- msgir
- msgopen
- msgreturndatasize
- msgscan
- msr
- num_activeprocessors
- num_all_devices
- num_devices
- num_jtag_chains
- num_jtag_devices
- num_processors
- num_uncore_devices
- openipc
- pause
- physical
- port
- pow
- print cycles
- printf
- proc
- processorcontrol
- processorfamily
- processormode
- processors
- processortype
- projectpath
- putchar
- puts
- rand
- readsetting
- reconnect
- Register Access
- reload
- reloadproject
- remove
- reset
- restart
- return
- right
- runcontroltype
- safemode
- save
- savebreakpoints
- savelayout
- savewatches
- selectdirectory
- selectfile
- shell
- show
- sin
- sizeof
- sleep
- softbreak, softremove, softdisable, softenable
- sprintf
- sqrt
- srand
- step
- stop
- strcat
- strchr
- strcmp
- strcpy
- _strdate
- string [ ] (index into string)
- strlen
- _strlwr
- strncat
- strncmp
- strncpy
- strpos
- strstr
- _strtime
- strtod
- strtol
- strtoul
- _strupr
- swbreak
- switch
- swremove
- tabs
- tan
- tapdatashift
- tapstateset
- targpower
- targstatus
- taskattach
- taskbreak, taskremove, taskdisable, taskenable
- taskend
- taskgetpid
- taskstart
- tck
- time
- uncoreconfigure
- uncorescan
- #undef
- unload
- unloadproject
- upload
- use
- verify
- verifydeviceconfiguration
- verifyjtagconfiguration
- version
- viewpoint
- vpalias
- wait
- wbinvd
- while
- windowrefresh
- wport
- writesetting
- yield
- yieldflag
OpenIPC Integration, Installation and Usage
Introduction
SourcePoint can be integrated with the OpenIPC component of Intelโs System Debugger (ISD). ย This is typically used to run Customer Scripts (CScripts) from a separate Command Line Interface (CLI) window. ย CScripts are a collection of Python scripts provided by Intel to assist customers with platform debug and validation.
Installation
ISD is not installed with SourcePoint. ย It must be obtained separately from Intel which requires a signed Non-Disclosure Agreement (NDA).
CScripts are written in Python. Currently CScripts require either Python 2.7 or Python 3.6. Depending on the ISD package version, either Python 2.7, Python 3.6, or both will be installed on the Host PC as part of the installation process. ISD uses 64 Bit versions of Python with OpenIPC, hence, 32 Bit Python is not supported.
Note: Newer ISD installs have removed support for Python 2.7
Usage
There are two usage modes: SourcePoint starts OpenIPC or OpenIPC starts SourcePoint in a tool mode (no visible GUI), which is used as a transport layer to the ASSET emulator hardware (ECM). ย ย
SourcePoint Starts OpenIPC
This usage mode is for current SourcePoint customers who are used to running SourcePoint but would also like to be able to open a CLI to run CScripts. ย
The user starts SourcePoint first and needs to enable OpenIPC (Options | Preferences | IPC). Select the target system type from the drop-down list then and close the options window. The user will then need to open a SourcePoint command window, and type: OpenIPC. SourcePoint will automatically open a CLI and it will become the focus window. At this point, the user can still use the functions of the main SourcePoint GUI.
To run the CScripts, the user can type: arium.runfile() as in previous versions of SourcePoint. Once the CScripts are completed, the user can exit from the CScripts, exit() and close the CLI window. However, when SourcePoint is closed, it will automatically close the CLI window regardless of exiting the CScripts.
OpenIPC Starts SourcePoint
This usage mode is for customers who normally use the CLI to run CScripts but may have never used SourcePoint. ย ย
The user opens the CLI and starts OpenIPC (see Sample Code below). ย OpenIPC automatically starts SourcePoint in the background. ย SourcePoint is started in tool mode, where the SourcePoint UI is not visible, and appears as a process rather than as an application. ย
When the user closes the CLI, OpenIPC automatically closes SourcePoint.
Note: When OpenIPC starts, if it detects SourcePoint is already running, it will connect to that SourcePoint rather than starting a new instance. ย When the user closes the CLI, OpenIPC will leave SourcePoint running since it didnโt start it.
SourcePoint Configuration
Configuration settings are located in the Preferences dialog (Options | Preferences | IPC). ย The Enable and Target controls in this tab are used when using the "SourcePoint starts IPC" mode. ย The Update Settings button can be used to enable the "IPC Starts SourcePoint" mode. ย This tells IPC which version of SourcePoint to run, and which project file to loadโ. ย See IPC_Tab for more information.
A complete guide on how to install and configure OpenIPC can be seen in Customer Advisory Bulletin #48 on the SourcePoint Community Site (https://sourcepointhelp.com/)
Sample Code
The following code can be used to start SourcePoint from the Python CLI, and validate the connection to the target
import ipccli
ipc = itp = ipccli.baseaccess( )
ipc.devicelist()
ย
ย
ย