Promira Platform System User Manual v1.33.001
Contents
1. The Promira Serial Platform is USB 2 0 compliant and will operate as a high speed 480 Mbps device on a USB 2 0 hub or host controller For additional information see table 15 4 3 Physical Specifications Dimensions W x D x L 77 5 mm x 29 2 mm x 115 6 mm 3 05 x 1 15 x 4 55 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 e Weight 153 g 0 34 Ibs 4 4 Promira Boot Process 4 4 1 Promira General Boot Process 6 Promira platform is off and 3 leds are off Power on Promira platform by connecting it to computer USB connector In about 1 s right led turns red In about 5 s right led turns blue Issue Promira API function pm_load or connect Promira platform to Control Center Serial or Flash Center In about 1 us right led turns green and Promira platform is ready to transfer data 4 4 2 Promira FW Update Boot Process N xak k oO O e e N DOR Right led is green and Promira platform is ready to transfer data Issue FW update in Control Center Serial or Promira Update Utility 3 leds turn off In about 1 s right led turns red In about 5 s all 3 leds turn blue Promira platforms appears as a hard drive on the computer Copy pmu file to Promira hard drive on the computer Eject safely the Promira hard drive from the computer Reboot Promira platform by disconnecting and connecting the USB cable In about 1 s right led turns red In about 5 s all 3 leds tu2. Figure 3 Windows IPv4 Properties dialog 9 Select OK and Close to dismiss the dialogs 10 In order to make sure it is ready or to know the IP address of the Promira Serial Platform right click on the USB Ethernet RNDIS Gadget adapter select Status and then select Details The IP address assigned to the network interface on the host PC is will be in the format of 10 x x x and is listed as the IPv4 Address The IP address of the device will be at the preceding address For example the image below shows 10 1 0 2 for the host IP address The device address will then be 10 1 0 1 This device address will also be displayed in the Control Center software and will be needed when connecting to the device using the API 13 oe TOTAL PHASE Promira Platform System User Manual v1 33 001 Jetwork Connection Details Network Connection Details Property Value Connection specific DN Description RNDIS Ethemet Gadget Physical Address 90 8C 09 01 00 02 DHCP Enabled Yes IPv4 Address 10 1 0 2 IPv4 Subnet Mask 255 255 255 252 Lease Obtained Thursday November 13 2014 10 06 42 Lease Expires Monday January 18 2038 7 14 08 PM IPv4 Default Gateway 10 1 0 1 IPv4 DHCP Server 10 1 0 1 IPv4 DNS Server IPv4 WINS Server NetBIOS over Tcpip En Yes Link4ocal IPv6 Address fe 80 1d4 2323 ec7d 7dd4 23 IPv6 Default Gateway IPv6 DNS Server lt TI aC Figure 4 Windows Connection Details 1
3. The Promira platform can be connected to the computer through the Ethernet port The Promira network preference for Ethernet is configurable by the Control Center Serial The Promira platform can be configured to static IP addressing or dynamic IP addressing DHCP The default network preferences of the Promira platform for Ethernet is a static and its IP address is 192 168 11 1 This IP address can be changed using the promira command line application provided in the util folder in the Promira API package For more details see the Control Center Serial manual section 2 8 Configuring Network Preference and the README txt file in the API package 5 3 Detecting IP addresses To detect the IP addresses to which the Promira Serial Platforms are attached use the pm find devices routine as described in following API documentation Alternatively the Control Center software can be used to list the available devices 5 4 Dynamically Linked Library The Promira requires the Promira DLL to operate and is only compatible with the Promira Serial Platform In addition to the Promira DLL the Aardvark Compatibility DLL is provided to make the Aardvark API available for legacy and compatibility purposes 5 4 2 DLL Location Total Phase provides language bindings that can be integrated into any custom application The default behavior of locating the Promira DLL and the Aardvark Compatibility DLL is dependent on the operating system platform and specific pr
4. Total Phase product be used in such an unauthorized manner Buyer agrees to indemnify and hold harmless Total Phase its officers employees affiliates and distributors from any and all claims arising from such use even if such claim alleges that Total Phase was negligent in the design or manufacture of its product 8 3 Contact Information Total Phase can be found on the Internet at http www totalphase com If you have support related questions please go to the Total Phase support page at http www totalphase com support For sales inquiries please contact sales totalphase com 35 Na TOTAL PHASE Promira Platform System User Manual v1 33 001 2003 2015 Total Phase Inc All rights reserved 36
5. by the binding function The error code is PM UNABLE TO LOAD LIBRARY for the management API and PS APP UNABLE TO LOAD LIBRARY for the application API 5 4 3 DLL Versioning The Promira Compatibility DLL checks to ensure that the firmware of a given device is compatible Each DLL revision is tagged as being compatible with firmware revisions greater than or equal to a certain version number Likewise each firmware version is tagged as being compatible with DLL revisions greater than or equal to a specific version number Here is an example DLL v1 20 compatible with Firmware gt v1 15 Firmware v1 30 compatible with DLL gt v1 20 17 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 Hence the DLL is not compatible with any firmware less than version 1 15 and the firmware is not compatible with any DLL less than version 1 20 In this example the version number constraints are satisfied and the DLL can safely connect to the target firmware without error If there is a version mismatch the API calls to open the device will fail See the API documentation for further details 18 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 6 Firmware 6 1 Field Upgrades 6 1 1 Upgrade Philosophy The Promira Serial Platform is designed so that its internal firmware FW can be upgraded by the user thereby allowing the inclusion of any performance enhancements or critical fixes available after t
6. integrate application interface o Upgradeable Firmware over USB Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 1 Revision History 1 1 Changes in version 1 33 Added features for Promira platform with eSPI Analysis Application 1 2 Changes in version 1 32 Fixed the connectivity issue of the first attempt to connect the Promira platform to the Promira API pm_load function after the device reset 1 3 Changes in version 1 31 Added features for Promira platform I C Active Level 2 Application and SPI Active Level 3 Application 1 4 Changes in version 1 30 Added features for Promira platform SPI Active Level 2 Application Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 2 General Overview The Promira Serial Platform with the I C SPI Active applications and eSPI Analysis application supports 1 C master slave active modes Single Dual and Quad SPI master slave active modes and Single Dual and Quad eSPI analysis modes The Promira platform supports up to 8 SPI SS CS signals up to 16 GPIO signals and up to 11 eSPI Digital IO signals depending on purchased application The Promira platform connects to an analysis computer via Ethernet or Ethernet over USB The applications installed on the Promira Serial Platform are field upgradeable and future proof Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 3 Applications Table 1 1 Applications Description A
7. 1 Select OK and Close to dismiss the dialogs Linux 1 Download the Promira Serial Platform Linux support files from the website and follow the instructions in the README txt file 2 Connect Promira to PC with USB cable 3 Use ifconfig a to determine the network interface of Promira If you do not recognize which one is the new interface compare the lists from ifconfig a before and after plugging in the device 14 TOTAL PHASE Promira Platform System User Manual v1 33 001 4 The Promira Serial Platform will be shown as tppx Mac OS X 1 Connect Promira to PC with USB cable 2 Select Network under System Preferences 3 Select Total Phase Promira Platform e o Network lt gt Show All Q Location Automatic Wi Fi gt e e Status Connected Total Phase Promira platform is currently dez n GG active and has the IP address 10 1 0 2 Onec w lt Configure IPv4 Using DHCP e Plugabl 3000 lt gt IP Address 10 1 0 2 Subnet Mask 255 255 255 252 e FireWire Ked Not ect z Router 10 1 0 1 Bluetooth PAN ONS Server 0 0 0 0 0 0 0 0 Search Domains Ie Advanced d Click the lock to prevent further changes Assist me Revert Apply Figure 5 Mac OS X Network Preferences window 4 Select Using DHCP from the Configure IPv4 dropdown list box 15 TOTAL PHASE Promira Platform System User Manual v1 33 001 5 Select Apply to apply the changes 5 2 2 Ethernet
8. Only a link to the Total Phase download area can be provided on such public websites Total Phase shall in no event be liable to any party for direct indirect special general incidental or consequential damages arising from the use of its site the software or documentation downloaded from its site or any derivative works thereof even if Total Phase or distributors have been advised of the possibility of such damage The software its documentation and any derivative works is provided on an as is basis and thus comes with absolutely no warranty either express or implied This disclaimer includes but is not limited to implied warranties of merchantability fitness for any particular purpose and non infringement Total Phase and distributors have no obligation to provide maintenance support or updates Information in this document is subject to change without notice and should not be construed as a commitment by Total Phase While the information contained herein is believed to be accurate Total Phase assumes no responsibility for any errors and or omissions that may appear in this document 8 2 Life Support Equipment Policy Total Phase products are not authorized for use in life support devices or systems Life support devices or systems include but are not limited to surgical implants medical systems and other safety critical systems in which failure of a Total Phase product could cause personal injury or loss of life Should a
9. Promira Serial Platform ry The Promira Serial Platform with l C SPI Active Applications and eSPI Analysis Application allows developers to interface a host PC TOTAL to a downstream embedded system environment transfer serial P H AS E messages using the 12C and SPI protocols and non intrusively monitors eSPI data Supported products PROMS Promira Serial Platform e IC Two wire interface Standard mode 100 kHz Fast mode 400 kHz Fast mode Plus 1 MHz o High Speed mode 3 4 MHz o Master and slave functionality Promira Serial Platform o Master Slave Bit Rate 1 kHz to 3 4 MHz System o Target Power 5V or 3 3V User Manual v1 33 001 o IO Power 0 9V 3 45V SPI Four to Six wire Interface November 20 2015 Single Dual and Quad SPI functionality o Master and Slave functionality o Master Bit Rate 31 kHz to 80 MHz o Slave Bit Rate 31 kHz to 20 MHz o Up to eight SS signals o Configurable slave select polarity Target Power 5V or 3 3V o O Power 0 9V 3 45V e GPIO General Purpose Input Output o Up to sixteen general purpose signals on shared and dedicated pins Selectable polarity e eSPI Eight wire Interface o Non intrusive eSPI monitoring up to 66 MHz o Single Dual and Quad eSPI functionality o Two CS Signals Two Alert Signals o Two Reset Signals Eleven Digital IO Signals o Target Power 5V or 3 3V o 1O Power 1 8V Software o Windows Linux and Mac OS X compatible Easy to
10. User Manual v1 33 001 PromiraVersion version Return the version matrix for the system connected to the given handle Arguments promira handle of the connection to the Promira Serial Platform version pointer to pre allocated structure Return Value A status code is returned with PM_OK on success Specific Error Codes None Details The PromiraVersion structure describes the various version dependencies of application components It can be used to determine which component caused an incompatibility error struct PromiraVersion Software firmware and hardware versions ul6 software ul6 firmware ul6 hardware FW requires that SW must be gt this version ul6 sw req by fw SW requires that FW must be gt this version ul6 fw req by sw API requires that SW must be gt this version ul6 api req by sw year If the handle is 0 or invalid only software fw_req by sw and api req by sw version are set 24 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 Sleep pm_sleep_ms int pm sleep ms u32 milliseconds Sleep for given amount of time Arguments milliseconds number of milliseconds to sleep Return Value This function returns the number of milliseconds slept Specific Error Codes None Details This function provides a convenient cross platform function to sleep the current thread using standard operating system functions The accu
11. Windows Change adapter settings window 7 Double click on Internet Protocol Version 4 IPv4 in u Local Area Connection 5 Properties pe USB Ethemet RNDIS Gadget This connection uses the following items 0M Parallels Shared Folders M 0 Client for Microsoft Networks Z QoS Packet Scheduler 2 File and Printer Sharing for Microsoft Networks Intemet Protocol Version 6 TCP IPv6 rice Protocol version 4 1CP Pv 4 Link Layer Topology Discovery Mapper 1 0 Driver Link Layer Topology Discovery Responder Description Transmission Control Protocol Intemet Protocol The default wide area network protocol that provides communication across diverse interconnected networks 12 Na TOTAL PHASE Promira Platform System User Manual v1 33 001 Figure 2 Windows Network Interface Properties dialog 8 Select Obtain IP address automatically and also select Obtain DNS server address automatically PE Internet Protocol Version 4 TCP IPv4 Properties 2 En General Alternate Configuration You can get IP settings assigned automatically if your network supports this capability Otherwise you need to ask your network administrator for the appropriate IP settings Use the following IP address Obtain DNS server address automatically Use the following DNS server addresses Validate settings upon exit Pr
12. alue string in bytes Specific Error Codes PM INVALID LICENSE The installed license is corrupt or invalid PM INVALID APP The application name is invalid PM INVALID FEATURE The feature name is invalid Details The va lue argument will be filled with a string containing the value of the feature The feature must be one of those provided by pm_features for this app Pass a value of 0 for value and value size to request the total length of the value string Note this length does not include the null terminating character Feature Description pm_feature_description int pm feature description Promira promira const char app const char feature u16 desc size u08 desc Return the description of a feature for the application Arguments promira handle of the connection to the Promira Serial Platform app name of the application feature name of the feature desc_size number of bytes in desc desc buffer to place the description string Return Value The length of the description string in bytes Specific Error Codes 32 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 PM INVALID LICENSE The installed license is corrupt or invalid PM INVALID APP The application name is invalid PM INVALID FEATURE The feature name is invalid Details The desc argument will be filled with a string containing the description of the feature The feature must be one of those provided by pm_features for this
13. app Pass a value of 0 for desc and desc_ size to request the total length of the description string Note this length does not include the null terminating character 7 5 Error Codes Table 5 Management Error Codes Literal Name Valu PM OK e oook PM_UNABLE_TO_LOAD LIBRARY unable to load library 1 pm_status_string return value PM_UNABLE_TO_LOAD_DRIVER z PM_UNABLE TO LOAD FUNCTION PM_INCOMPATIBLE_LIBRARY PM_INCOMPATIBLE_DEVICE PM COMMUNICATION ERROR 6 communication error PM_UNABLE_TO_OPEN unable to open device PM_UNABLE_TO_CLOSE 8 unable to close device PM_INVALID_HANDLE 9 invalid device hande PM_INVALID_LICENSE PM_UNABLE_TO_LOAD APP PM_INVALID DEVICE 33 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 PM_INVALID_ FEATURE PM_NETCONFIG _ ERROR PM_INVALID_IPADDR PM_INVALID NETMASK PM_INVALID SUBNET PM_NETCONFIG_UNSUPPORTED PM_NETCONFIG_ LOST CONNECTION 206 34 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 8 Legal Contact 8 1 Disclaimer All of the software and documentation provided in this manual is copyright Total Phase Inc Total Phase License is granted to the user to freely use and distribute the software and documentation in complete and unaltered form provided that the purpose is to use or evaluate Total Phase products Distribution rights do not include public posting or mirroring on Internet websites
14. ersion Return the version matrix for the given application in the system connected to the given handle Arguments 26 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 promira handle of the connection to the Promira Serial Platform app name application name version pointer to pre allocated structure Return Value A status code is returned with PM_OK on success Specific Error Codes None Details This function is to check the version number of the application without loading it Only firmware hardware and sw req by fw version are set Launch an Application pm_load int pm_load Promira promira const char app name Launch an application Arguments promira handle of the connection to the Promira Serial Platform app name application name to be launched Return Value A Promira status code is returned with PM_OK on success Specific Error Codes PM APP_NOT FOUND There is no application with the specified name PM UNABLE TO LOAD APP Unable to load the application Details The Promira Serial Platform can have more than one application Prior to the use of any subsystems in the application it needs to be launched The Promira Serial Platform with firmware version 0 65 or greater has one application and its name is com totalphase promact_ is 27 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 Query Network Configurations pm_query_net int pm query ne
15. es If status is PM_DEVICE_NOT_FREE the device is in use by another host and is not ready for connection Open a Promira Serial Platform pm_open Promira pm open const char net addr Open a connection to a Promira Serial Platform Arguments 22 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 net_addr net address of the Promira Serial Platform It could be an IPv4 address or a host name Return Value This function returns a Promira handle which is guaranteed to be greater than zero if valid Specific Error Codes PM UNABLE TO OPEN The specified net address is not connected to a Promira Serial Platform PM INCOMPATIBLE DEVICE There is a version mismatch between the DLL and the firmware The DLL is not of a sufficient version for interoperability with the firmware version or vice versa Details None Close the Promira Device pm_close int pm_close Promira promira Close the connection to the Promira adapter Arguments promira handle of the connection to the Promira Serial Platform to be closed Return Value The number of devices closed is returned on success This will usually be 1 Specific Error Codes None Details If the promira argument is zero the function will attempt to close all possible handles thereby closing all connections to Promira Serial Platforms Version pm_version int pm version Promira promira 23 Na amp TOTAL PHASE Promira Platform System
16. es My Display adapters gt 3 DVD CD ROM drives gt ca IDE ATA ATAPI controllers Imaging devices f Disk Management Jungo Gy Services and Applications gt D Keyboards gt R Mice and other pointing devices b E Monitors gt Network adapters gt Other devices L la Total Phase Promira platform gt J Processors Sound video and game controllers lll System devices gt F Universal Serial Bus controllers b Otherwise close this window skip RNDIS driver installation in the next step and continue to the following step TOTAL PHASE Promira Platform System User Manual v1 33 001 3 Install RNDIS driver a Right click on Total Phase Promira platform device and select Update Driver Software When prompted to choose how to search for device driver software choose Browse my computer for driver software b Browse for driver software on your computer will come up Select Let me pick from a list of device drivers on my computer c A window will come up asking to select the device type Select Network adapters as RNDIS emulates a network connection Select your device s type from the list below Common hardware types OS Microsoft Common Controller For Windows Class Mobile devices Modems E Monitors Ly Multifunction adapters YF Multi port serial adapters Fe Network adapters o Network Client Network Protocol A Network Service Non Plug and Play Drive
17. es pm_features int pm features Promira promira const char app 30 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 u16 features size u08 features Return the features licensed for the application Arguments promira handle of the connection to the Promira Serial Platform app name of the application features size number of bytes in features features buffer to place the features string Return Value The length of the features string in bytes Specific Error Codes PM INVALID LICENSE The installed license is corrupt or invalid PM INVALID APP The application name is invalid Details The features argument will be filled with a colon separated string containing the names of features that are licensed for app Pass a value of 0 for features and features size to request the total length of the features string Note this length does not include the null terminating character Feature Value pm_feature_value int pm_feature value Promira promira const char app const char feature u16 value size u08 value Return the value of a feature for the application Arguments promira handle of the connection to the Promira Serial Platform app name of the application feature name of the feature 31 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 value size number of bytes in value value buffer to place the value string Return Value The length of the v
18. he receipt of the device For the Promira Serial Platform two FW version numbers are shown in the FW column in Control Center Serial GUI Configure Adapter window Flash Center GUI Add Adapters window and Data Center GUI connect window The first one is the version number of the FW system and the second one is the version number of the FW application For example the FW numbers 1 10 1 00 represent FW system v1 10 and FW application v1 00 Promira API has four main FW functions pm_version pm_app_version ps_app_ version and pa app version Promira API function pm_version returns FW system version and Promira API functions pm_app_version ps_app_version and pa_app_version return FW application version 6 1 2 Upgrade Procedure Please refer to the Promira FW Update Utility package for the procedure to upgrade the firmware on the Promira Serial Platform 19 TOTAL PHASE Promira Platform System User Manual v1 33 001 7 API Documentation 7 1 Introduction The Promira API documentation that follows is oriented toward the Promira Rosetta C bindings The set of Promira API functions and their functionality is identical regardless of which Rosetta language binding is utilized The only differences will be found in the calling convention of the functions For further information on such differences please refer to the documentation that accompanies each language bindings in the Promira API Software distribution 7 2 General Data Type
19. mira status code is returned with PM_OK on success Specific Error Codes PM NETCONFIG ERROR Unable to configure network interface PM INVALID IPADDR Invalid IP address PM INVALID NETMASK Invalid network mask PM INVALID SUBNET The 192 168 12 x subnet is reserved It is an error to configure the Ethernet interface to any address in this subnet 29 TOTAL PHASE Promira Platform System User Manual v1 33 001 PM NETCONFIG LOST CONNECTION Applying the last settings has changed the IP address of the connection Any further access doesn t work since the connection to the device has lost and pm_close needs to be called to clean up the resources Details In order to enable Ethernet or DHCP for Ethernet call this function with 1 as data In order to disable call this with 0 as data Network interface can be configured by the promira utility pb romira exe or promira See the section Ethernet for more detail Read License pm_read_license int pm_read license Promira promira int buf size u08 buf Read the entire license Arguments promira handle of the connection to the Promira Serial Platform buf size number of bytes in buf buf buffer to place the license string Return Value The length of the license in bytes Specific Error Codes PM_INVALID_LICENSE The installed license is corrupt or invalid Details Pass a value of 0 for buf and buf_size to request the total length of the license Featur
20. ogramming language environment For example for a C or C application the following rules apply On a Windows system this is as follows 1 The directory from which the application binary was loaded 2 The applications current directory 3 32 bit system directory for a 32 bit application Examples 1 c Windows System32 Windows 7 8 32 bit 2 c Windows SysWow64 Windows 7 8 64 bit 16 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 4 64 bit system directory for a 64 bit application Examples 1 C Windows System32 Windows 7 8 64 bit 5 The Windows directory Ex c Windows 6 The directories listed in the PATH environment variable On a Linux system this is as follows 1 First search for the shared object in the application binary path If the proc filesystem is not present this step is skipped 2 Next search in the applications current working directory 3 Search the paths explicitly specified in LD LIBRARY PATH 4 Finally check any system library paths as specified in etc ld so conf and cached in etc ld so cache On a Mac OS X system this is as follows 1 First search for the shared object in the application binary path 2 Next search in the applications current working directory 3 Search the paths explicitly specified in DYLD LIBRARY PATH 4 Finally check the usr lib and usr local lib system library paths If the DLL is still not found an error will be returned
21. pplication Max Digital Slave Slave Slave Bitrate lO Response Response Response Master Signals Signals Signals Level 1 Capability Size 1 Slave 1 MHz I C Active Advanced 1 slave 256 Bytes Level 1 Slave address 1 response IC Active 3 4 3 4 12 NA Advanced 1 slave 256 Bytes Level 2 Slave address 1 response SPI Active 12 5 12 5 NA 1 Advanced 1 response 256 Bytes Level 1 Slave SPI Active 40 20 12 NA 3 Advanced Advanced 256 Bytes Level 2 Slave Slave 1 Ultra Slave response Ultra Slave Multiple responses SPI Active 80 20 16 NA Advanced Advanced Advanced Level 3 Slave Slave 1 Slave 256 Ultra Slave response Bytes Ultra Ultra Slave Slave Up multiple to 64 responses MBytes eSPI NA 11 2 NA NA NA Analysis Notes 1 Ultra Slave will be released at a future date Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 4 Hardware Specifications 4 1 Pinouts 4 1 1 Pin Description Table 2 1 Pin Description Target Connector Vier Software configurable Vcc target power supply NC 3 3V 5V Vier Software configurable Vcc target power supply NC 3 3V 5V Software configurable Vcc IO level power supply NC O 9V to 3 45V Software configurable Vcc IO level power supply NC 0 9V to 3 45V Ground Connection 1 The pin description in this table is for Promira FW v1 30 v1 30 and above 4 2 USB 2 0 Compliance 2 10 12 16 18 28 30 34 Note
22. racy of this function depends on the operating system scheduler This function will return the number of milliseconds that were actually slept Status String pm_status_ string const char pm status string int status Return the status string for the given status code Arguments status status code returned by a Promira application function Return Value This function returns a human readable string that corresponds to status If the code is not valid it returns a NULL string Specific Error Codes None 25 TOTAL PHASE Promira Platform System User Manual v1 33 001 Details None Applications pm_apps int pm apps Promira promira u16 apps size u08 apps Return the installed applications Arguments promira handle of the connection to the Promira Serial Platform apps size number of bytes in apps apps buffer to place the applications string Return Value The length of the apps string in bytes Specific Error Codes PM INVALID LICENSE The installed license is corrupt or invalid Details The apps argument will be filled with a colon separated string containing the names of applications that are licensed for this device Pass a value of 0 for apps and apps_size to request the total length of the applications string Note this length does not include the null terminating character Application Version pm_app_version int pm app version Promira promira const char app name PromiraVersion v
23. returned when both Ethernet and Ethernet over USB are enabled If the input array is NULL it is not filled with any values If there are more devices than the array size as specified by num_devices only the first num_devices IP addresses will be written into the array Find Devices pm_find_devices_ext int pm find devices ext int num devices u32 devices 21 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 int num ids u32 unique ids int num statuses u32 statuses Get a list of IP addresses and unique IDs to which Promira Serial Platforms are attached Arguments num devices maximum number of IP addresses to return devices array into which the IP addresses are returned num ids maximum number of unique IDs to return unique ids array into which the unique IDs are returned num statuses maximum number of statuses to return statuses array into which the statuses are returned Return Value This function returns the number of devices found regardless of the array sizes Specific Error Codes None Details This function is the same as pm_find_devices except that is also returns the unique IDs of each Promira adapter The IDs are guaranteed to be non zero if valid The IDs are the unsigned integer representation of the 10 digit serial numbers The number of devices and IDs returned in each of their respective arrays is determined by the minimum of num_devices num_ids and status
24. rn blue In about 5 s all 3 leds flash blue one at a time Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 13 Promira platform automatically reboots Bullets 1 6 in General Boot Process section are occurred 4 4 3 Promira License Update Boot Process The steps are similar to the Promira FW Update Boot Process steps However it is faster and without step 12 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 5 Software 5 1 Compatibility 5 1 1 Overview The Promira Serial Platform software is offered as a 32 bit or 64 bit Dynamic Linked Library or shared object The specific compatibility for each operating system is discussed below 5 1 2 Windows Compatibility The Promira Serial Platform software is compatible with 32 bit and 64 bit versions of Windows 7 and Windows 8 8 1 Windows XP Vista 2000 and legacy 16 bit Windows 95 98 ME operating systems are not supported 5 1 3 Linux Compatibility The Promira Serial Platform software is compatible with all standard 32 bit and 64 bit distributions of Linux with kernel 2 6 and integrated USB support When using the 32 bit library on a 64 bit distribution the appropriate 32 bit system libraries are also required 5 1 4 Mac OS X Compatibility The Promira Serial Platform software is compatible with Intel versions of Mac OS X 10 5 Leopard 10 6 Snow Leopard 10 7 Lion 10 8 Mountain Lion 10 9 Mavericks and 10 10 Yosemite In
25. rs ED PCMCIA adapters d In the Select Network Adapter window select Microsoft Corporation from the Manufacturer list Under the list of Network Adapter select Remote NDIS compatible device 10 J TOTAL PHASE Promira Platform System User Manual v1 33 001 Select Network Adapter Ku Click the Network Adapter that matches your hardware then click OK If you F az installation disk for this feature click Have Disk Manufacturer Network Adapter Marvell E wlRemote NDIS based Internet Sharing Device Microsoft ER Remote NDIS Compatible Device Microsoft Corporation Matarals Inc 4 e The Total Phase Promira platform device is now installed and ready for use Windows has successfully updated your driver software Windows has finished installing the driver software for this device K M Remote NDIS Compatible Device 4 From the Start menu select Control Panel Network and Internet Network and Sharing Center 5 Select Change adapter settings on the left panel 6 Right click on the USB Ethernet RNDIS Gadget adapter select Properties 11 TOTAL PHASE Promira Platform System User Manual v1 33 001 OOOO _ _ Search Network Connections XAL Organize v Disable this network device v Fil A by Local Area Connection 2 Local Area Connection 5 aaa Network A Unidentified network Intel R PRO 1000 MT Network C E USB Ethernet RNDIS Gadget Figure 1
26. s The following definitions are provided for convenience All Promira data types are unsigned typedef typedef typedef typedef typedef typedef typedef typedef typedef 7 3 Notes on Status Codes unsigned unsigned unsigned unsigned Signed Signed Signed signed float char short int long long char short int long long u08 ul6 u32 u64 s08 s16 s32 s64 f32 Most of the Promira API functions can return a status or error code back to the caller The complete list of status codes is provided at the end of this chapter and in the Promira applications user manuals All of the error codes are assigned values less 20 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 than 0 separating these responses from any numerical values returned by certain API functions 7 4 Application Management Interface 7 4 1 Application Management Find Devices pm_find_devices int pm find devices int num devices u32 devices Get a list of IP addresses to which Promira adapters are attached Arguments num devices maximum size of the array devices array into which the IP addresses are returned Return Value This function returns the number of devices found regardless of the array size Specific Error Codes None Details Each element of the array is 4 byte integer value represented IP address For instance 192 168 1 2 is 0x0201A8CO Two IP addresses to same device might be
27. stallation of the latest available update is recommended 5 2 Connectivity There are two ways to connect to the Promira Serial Platform via USB or via Ethernet No additional device drivers are required for using either method 5 2 1 USB The Promira Serial Platform uses Ethernet over USB which allows the host software to connect to the adapter via an IP address To use this interface connect the device to your PC with a USB cable and follow the instructions below to set up the connection on the PC TOTAL PHASE Promira Platform System User Manual v1 33 001 For Ethernet over USB the Promira Serial Platform is a DHCP server that dynamically distributes network configuration parameters such as IP addresses for interfaces and services Windows 1 Connect Promira to PC with USB cable 2 After the device is connected to the development PC Windows will automatically search for the appropriate RNDIS driver To verify the drive is installed correctly right click on Computer and select Manage From System Tools select Device Manager If the Total Phase Promira platform shows up with an exclamation mark continue to the next step and install the driver File Action View Help e 2 ED Hi Er amp 2 Computer Management Local a System Tools Task Scheduler gt Event Viewer gt Shared Folders Performance gd Device Manager 4 Storage gp Batteries gt gl Computer gt Disk driv
28. t Promira promira PromiraNetCommand cmd int buf size u08 buf Get the Ethernet network interface properties for this Promira handle Arguments promira handle of the connection to the Promira Serial Platform cmd enumerated values specifying the network configuration to get See Table 3 buf size size of the array for network configuration buf array into which the network configuration is returned Table 3 cmd enumerated types Return Value Length of the network configuration string is returned on success Specific Error Codes None Details 28 Na amp TOTAL PHASE Promira Platform System User Manual v1 33 001 For PM NET ETH ENABLE and PM NET ETH DHCP ENABLE 1 will be returned when enabled otherwise 0 will be returned Configure Network Configuration pm_config_net int pm_config net Promira promira PromiraNetCommand cmd const char data Configure the Ethernet network interface Arguments promira handle of the connection to the Promira Serial Platform cmd enumerated values specifying the network configuration to get See Table 4 data network configuration data Table 4 cmd enumerated types PM NET ETH ENABLE Enable Disable Ethernet PM NET ETH IP Configure the IP address of Ethernet PM NET ETH NETMASK Configure the netmask of Ethernet PM NET ETH DHCP ENABLE Enable Disable DHCP for Ethernet PM NET ETH DHCP RENEW Renew the DHCP for Ethernet Return Value A Pro
Download Pdf Manuals
Related Search