SUSI-SQFlash User`s Manual
Contents
1. one solution 2 Disable SID function if unused sectors cannot be found 3 Change all APIs to SQFlash_xxx formate 3 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Table of Contents INTRODUCTION EE RE EE OR RE N an aa iaaa 5 SYSTEM REQUIREMENTS siese osse ske siese bee ske ie osse ie aen b eene iese is etse ewe iet eed sie Ed 6 e Eldo UE 6 SEENEN 8 EIERE EE EE 8 INSTALLATION ME EE EE OE OE OR ENEA 9 SUSI SQFLASH PDM UTILITY esse esse esse EER KEREN REENEN EER EER EER AE RR AE EE EE 10 First Window Access GOP ii Ee Ke EK oe Ee oe EE 11 Main Window SUS SOFlash PDM ee ee ee ee ee ee ee ee ee ee 12 About Window Advantech Copyright Re 13 Get Code Window Protecting Sample Code 14 SMART Window Get SMART attrbute iese ee ee ee ee ee EE Ee ee ee ee ee 15 SUSSOFLASH PDM APIE esse se over See Sa de Eed Gee des de Ge Ve ENEE 16 Programming Overview EE 16 Initialize od 9 6 116 RE EE N 19 GetSmartAttribute Function se sesse see ese see ee vee ee gee 20 ATA SMART ATIR KEE 21 SetSecuritylD Function AE EE RE EE EE EE 22 EHNEN sesse EE BE e GE ee Ee 23 ClearSecuritylD FUNGUS EE DE Ee ES ES DE OE Ee Ee Ge Ge 24 IlsSupportFlashLock Function iss ss EE SE Ge Ee Ge GE GE Re ey Ge Eg Ed ed 25 lIeFlashLockEnable EUNCHOM sesse kes eke sies SKEER ER NRS KG soes ED EER REEN Reen ee EE 26 EnableFlashloek FUNCUON asses es si se ssE se si se es se ei ee se 27 DisableFlashLock Function se2. SOFlash GetSecuritylD szSecuritylD sizeof szSecurityID if bRet FALSE MessageBox NULL L Get security ID failed NULL NULL SQFlash_UniInitialize return 0 BOOL bCmpSucc wesemp SECURE_ID szSecurityID 0 if BCmpSucc TRUE 14 of 29 OVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM SMART Window Get SMART attribute Click Get SMART to S M A R T attribute in a new dialog Max Program In PATA DOM max program and erase cycles Average Program In PATA DOM average program and erase cycles Power On Time Power on accumulates time ECC Count Error correct code number of times counting Endurance Check Endurance Check is the result of Average P E cycles Max P E cycles SMART Attribute Endurance Check Max Program 100000 Average Program 8 Power On Time 3 Hour 56 Minute 19 Second ECC Count O AG TA EmbCore Embedded Software amp Modules 15 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM SUSI SQFlash PDM API Programming Overview SQFlash PDM lib is a static link library that exports all the API functions 1 SQFlash_Initialize Input valid access code in order to initial SUSI SQFlash 2 SQFlash_Unlnitialize Uninitialize SQFlash library 3 SQFlash_GetSmartAttribute S M A R T attribute contains 5 data in Advantech SQFlash Max Program In PATA DOM max program and erase cycles Ave
3. 22 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM GetSecurityID Function Syntax BOOL SQFlash_GetSecurityID PCHAR pszSecuritylD DWORD cchBuffer Parameters pszSecuritylD out Pointer to the buffer that will receive the Security ID cchBuffer in Specifies the maximum number of characters to copy to the buffer including the NULL character Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 23 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM ClearSecurityID Function Syntax BOOL SOFlash ClearSecuritylD Parameters None Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 24 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM IsSupportFlashLock Function Syntax BOOL SQFlash_IsSupportFlashLock HWND hWnd UINT msgID Parameters hWnd in Handle to a window This window will receive processing progress information by window message msgID in User defined window message for processing progress information The wParam with this message represents current progress and IParam is the maximum progress value Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 25 of 29 UOVS TT EmbCore Embedded Software amp Modules SUSI
4. PDM firmware version 2 A1E Environments Operating Systems that SUSI SQFlash supports include Windows XP Embedded Windows XP Pro or Home Edition 8 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Installation SUSI SQFlash software package doesn t need to install into your operation system However you must have Advantech SQFlash in your IDE slot and a valid product key to access the utility or API Please contact Advantech to get legal access code 9 of 29 DAG TN EmbCore Embedded Software amp Modules SUSI SQFlash PDM SUSI SQFlash PDM Utility SUSI SQFlash PDM is a utility to manage Advantech SQFlash PDM to access security zone Flash Lock and S M A R T information Key features Product key protected Security ID Read Write Flash Lock Protecting sample code generator S M A R T attribute This utility package contains 9 files File Name Description SQFlash PDM exe Main program SQFlash PDM_DII dll SUSI SQFlash PDM Utility Library PieChartControls dll SUSI SQFlash PDM Utility Library Cpp ProtCode txt Protected sample code in C SQFlash PDM lib SUSI SQFlash PDM Static Library SQFlash PDM_d lib SUSI SQFlash PDM Debug mode Static Library SQFlash PDM h SUSI SQFlash PDM Header File ePFlash sys BIOS Flash Driver SQFlash PDM_PID pdf Access Code For security concern please import static library SQFlash PDM lib to implement your protecting mech
5. SQFlash PDM IsFlashLockEnable Function Syntax BOOL SQFlash_IsFlashLockEnable HWND hWnd UINT msgID Parameters hWnd in Handle to a window This window will receive processing progress information by window message msgID in User defined window message for processing progress information The wParam with this message represents current progress and IParam is the maximum progress value Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 26 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM EnableFlashLock Function Syntax BOOL SQFlash_EnableFlashLock LPCSTR pszPassword HWND hWnd UINT msgID Parameters pszPassword in Valid SN hWnd in Handle to a window This window will receive processing progress information by window message msgID in User defined window message for processing progress information The wParam with this message represents current progress and IParam is the maximum progress value Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 27 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM DisableFlashLock Function Syntax BOOL SQFlash_DisableFlashLock HWND hWnd UINT msgID Parameters hWnd in Handle to a window This window will receive processing progress information by window message msg
6. efficient time to market services to all worldwide customers Corporate Website www advantech com 29 of 29
7. 70 C Advantech SQFlash PDM 4G SLC 40pin HOR Top 0 70 C Advantech SQFlash PDM 8G SLC 40pin HOR Top 0 70 C Advantech SQFlash PDM 16G SLC 40pin HOR Top 0 70 C Advantech SQFlash PDM 2G SLC 40pin HOR Top 40 85 C Advantech SQFlash PDM 4G SLC 40pin HOR Top 40 85 C Advantech SQFlash PDM 8G SLC 40pin HOR Top 40 85 C Advantech SQFlash PDM 16G SLC 40pin HOR Top 40 85 C Advantech SQFlash PDM 2G SLC 40pin HOR Bottom 0 70 C Advantech SQFlash PDM 4G SLC 40pin HOR Bottom 0 70 C Advantech SQFlash PDM 8G SLC 40pin HOR Bottom 0 70 C Advantech SQFlash PDM 16G SLC 40pin HOR Bottom 0 70 C Advantech SQFlash PDM 2G SLC 40pin HOR Bottom 40 85 C Advantech SQFlash PDM 4G SLC 40pin HOR Bottom 40 85 C Advantech SQFlash PDM 8G SLC 40pin HOR Bottom 40 85 C Advantech SQFlash PDM 16G SLC 40pin HOR Bottom 40 85 C Advantech SQFlash PDM 2G SLC 40pin Vertical 0 70 C Advantech SQFlash PDM 4G SLC 40pin Vertical 0 70 C Advantech SQFlash PDM 8G SLC 40pin Vertical 0 70 C Advantech SQFlash PDM 16G SLC 40pin Vertical 0 70 C Advantech SQFlash PDM 2G SLC 40pin Vertical 40 85 C Advantech SQFlash PDM 4G SLC 40pin Vertical 40 85 C Advantech SQFlash PDM 8G SLC 40pin Vertical 40 85 C Advantech SQFlash PDM 16G SLC 40pin Vertical 40 85 C UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Software SUSI SQFlash v1 0 1802 1 utility and API are required Dot Net Framework 2 0 required SQFlash
8. DDT EmbCore Embedded Software amp Modules SUSI SQFlash User s Manual Version 1 0 1802 1 Advantech Co Ltd No 1 Alley 20 Lane 26 Rueiguang Road Neihu District Taipei 114 Taiwan R O C www advantech com UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Copyright Notice This document is copyrighted 2009 by Advantech Co Ltd All rights reserved Advantech Co Ltd Reserves the right to make improvements to the products described in this manual at any time Specifications are thus subject to change without notice No part of this manual may be reproduced copied translated or transmitted in any form or by any means without prior written permission of Advantech Co Ltd Information provided in this manual is intended to be accurate and reliable However Advantech Co Ltd assumes no responsibility for its use or for any infringements upon the rights of third parties which may result from its use All the trade marks of products and companies mentioned in this data sheet belong to their respective owners Copyright 1983 2009 Advantech Co Ltd All Rights Reserved Part No Version 1 0 1802 1 Printed in Taiwan 2009 06 16 2 of 29 UYS TT EmbCore Embedded Software amp Modules Version History SUSI SQFlash PDM Date Version Remark 2009 05 20 1 0 1719 1 1 New Version release 2009 06 16 1 0 1802 1 1 Integrate all SQFlash projects CF PDM SSD into
9. ID in User defined window message for processing progress information The wParam with this message represents current progress and IParam is the maximum progress value Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE 28 of 29 UOVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM About Advantech s Embedded Core Service Emb Core is an open business model that provides integrated software and module solutions to speed up application development The key proficiencies of Embedded Core Services are software firmware and hardware module integration capability that offer customized solutions For further information please email EmbCore advantech com About Advantech Founded in 1983 Advantech is a global leading ePlatform services provider of web based technology computing platforms and customization services to empower innovations in the connected eWorld Advantech cooperates closely with partners to help provide complete solutions for a wide array of applications in various industries Advantech delivers more than a thousand products and platform solutions in 5 main categories Industrial amp Network Computing Embedded Computing Applied Computing eVideo Solutions and eAutomation With more than 2 700 talented people Advantech operates an extensive support sales and marketing network in 18 countries and 36 major cities Advantech delivers
10. In order to help protect customers intellectual property Advantech has designed in Security ID feature for Advantech SQFlash Customers can easily implement security functions on their applications base on encrypted utility and library Flash Lock feature helps user to lock SQFlash to protect flash data not to be read a Monitor SQFlash Health Advantech SQFlash management package provides utility and API to get Self Monitoring Analysis and Reporting Technology S M A R T information from SQFlash cards Customer can monitor the flash storage health and design an early warning mechanism by life span detection 5 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM System Requirements Hardware Following hardware are required to run Advantech SUSI SQFlash PDM Utility for Windows XP 1 Processor Minimum Requirement A200 megahertz MHz processor such as the Intel Pentium Celeron family AMD K6 Athlon Duron family or compatible processor 2 RAM Minimum Requirement RAM size is dependent on the running applications and using XPE features 3 PATA DOM Requirement Advantech SQFlash PDM in IDE slot Part Number Description SQF PDMS2 2G HACE Advantech SQFlash PDM 2G SLC 44pin HOR 0 70 C SQF PDMS2 4G HACE Advantech SQFlash PDM 4G SLC 44pin HOR 0 70 C SQF PDMS2 8G HACE Advantech SQFlash PDM 8G SLC 44pin HOR 0 70 C SQF PDMS2 16G HACE Advantech SQFlash PDM 16G SLC 44pin HOR 0 70 C SQF
11. PDMS2 2G HAEE Advantech SQFlash PDM 2G SLC 44pin HOR 40 85 C SQF PDMS2 4G HAEE Advantech SQFlash PDM 4G SLC 44pin HOR 40 85 C SQF PDMS2 8G HAEE Advantech SQFlash PDM 8G SLC 44pin HOR 40 85 C SQF PDMS2 16G HAEE Advantech SQFlash PDM 16G SLC 44pin HOR 40 85 C SQF PDMS2 2G VACE Advantech SOFlash PDM 2G SLC 44pin Vertical 0 70 C SQF PDMS2 4G VACE Advantech SQFlash PDM AG SLC 44pin Vertical 0 70 C SQF PDMS2 8G VACE Advantech SQFlash PDM 8G SLC 44pin Vertical 0O 70 C 6 of 29 OVS TT EmbCore Embedded Software amp Modules SOF PDMS2 16G VACE SQF PDMS2 2G VAEE SQF PDMS2 4G VAEE SQF PDMS2 8G VAEE SQF PDMS2 16G VAEE SQF PDMS2 2G HBCE SQF PDMS2 4G HBCE SQF PDMS2 8G HBCE SQF PDMS2 16G HBCE SQF PDMS2 2G HBEE SQF PDMS2 4G HBEE SQF PDMS2 8G HBEE SQF PDMS2 16G HBEE SQF PDMS2 2G HCCE SQF PDMS2 4G HCCE SQF PDMS2 8G HCCE SQF PDMS2 16G HCCE SQF PDMS2 2G HCEE SQF PDMS2 4G HCEE SQF PDMS2 8G HCEE SQF PDMS2 16G HCEE SQF PDMS2 2G VBCE SQF PDMS2 4G VBCE SQF PDMS2 8G VBCE SQF PDMS2 16G VBCE SQF PDMS2 2G VBEE SQF PDMS2 4G VBEE SQF PDMS2 8G VBEE SOF PDMS2 16G VBEE 7 of 29 SUSI SQFlash PDM Advantech SOFlash PDM 16G SLC 44pin Vertical O 70 C Advantech SQFlash PDM 2G SLC 44pin Vertical 40 85 C Advantech SQFlash PDM 4G SLC 44pin Vertical 40 85 C Advantech SQFlash PDM 8G SLC 44pin Vertical 40 85 C Advantech SQFlash PDM 16G SLC 44pin Vertical 40 85 C Advantech SQFlash PDM 2G SLC 40pin HOR Top 0
12. anism Every user who wants to adopt SUSI SQFlash package should apply Access Code from Advantech first Once you enter a legal access code you re not allowed to change another product key on the same SQFlash 10 of 29 UOVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM First Window Access Code Please input a valid product key into this dialog You can find the product key in SQFlash PDM_PID pdf Once you type valid access code with this utility system will keep record and you won t need to type access code next time Enter Access Code NEE ENE NEE NEE 11 of 29 INN TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Main Window SUSI SQFlash PDM Software Protection Detect max and user defined length of Security ID Read or Write Security ID into hidden area Get protection code into application C sample Life monitoring Endurance Check Flash Lock Enable Disable Flash Lock feature SUSI SQFlash PDM Software Protection Security ID Max Length 256 bytes Security ID Length 9 bytes Get Protection Code into your Application Life Monitoring Flash Lock O Enable Disable AD ANTECH Flash Lock feature needs to be supported by Advantech BIOS and support list as Appendix If target platform didn t support this feature Flash Lock buttons will be gray out While user press Enable or Disable to change the status of Flash Lock a progress dialog as follow
13. f 29 UOVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM GetSmartAttribute Function Syntax BOOL SOFlash GetSmartAtftribute PATA SMART ATTR TABLE pASAT Parameters PASAT in Pointer to a ATA SMART ATTR TABLE structure to receive the Smart Attribute 20 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM ATA_SMART_ATTR_TABLE Structure The ATA_SMART_ATTR_TABLE Structure contains Smart Attributes Syntax typedef struct ATA SMART ATTR TABLE DWORD dwMaxProgram DWORD dwAverageProgram DWORD dwEnduranceRemainLife DWORD dwPowerOnTime DWORD dwEccCount VATA SMART ATTR TABLE PATA SMART ATTR TABLE Members dwMaxProgram Max Program Erase Cycles dwAverageProgram Average Program Erase Cycles dwEnduranceRemainLife Endurance Remain Life dwPowerOnTime Power On Time second dwEccCount ECC Count 21 of 29 UOVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM SetSecuritylD Function Syntax BOOL SQFlash_IsUnusedSectorExist Parameters None Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE Syntax BOOL SQFlash_SetSecurityID LPCSTR pszSecuritylD Parameters pszSecurityID in Pointer to a null terminated string to be used as the new Security ID Return Value If the function succeeds the return value is TRUE If the function fails the return value is FALSE
14. rage Program In PATA DOM average program and erase cycles Power On Time Power on accumulates time ECC Count Error correct code number of times counting Endurance Check Endurance Check is the result of Average P E cycles Max P E cycles 4 SQFlash_IsUnusedSectorExist Find available sector to restore security ID 5 SOFlash SetSecuritylD Support maximum length to 256 bytes security string which will write into the hidden area of Advantech SOFlash 6 SOFlash GetSecuritylD Read Security ID from hidden area 7 SOFlash ClearSecuritylD 16 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Clear Security ID from hidden area 17 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM 8 SQFlash_IsSupportFlashLock Check target platform support Flash Lock or not 9 SQFlash_IsFlashLockEnable Check target platform Flash Lock be enabled or not 10 SQFlash_EnableFlashLock Enable Flash Lock feature 11 SQFlash_DisableFlashLock Disable Flash Lock feature 18 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Initialize Function Syntax BOOL SQFlash_Initialize LPCSTR pszPassword Parameters pszPassword in Valid SN Return Value If the library was initialized successfully the return value is TRUE Otherwise the return value is FALSE Syntax Void SQFlash_Unlnitialize Parameters None Return Value None 19 o
15. s will be pop up Processing _ Warning Don t Turn Off Power or Reset System 12 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM About Window Advantech Copyright About SUSI SQFlash PDM for Windows XP Version 1 0 1802 1 c 2008 Advantech Corporation All right reserved Warning This computer program is protected by copyright law and international treaties Unanthorized reproduction or distribution of this program or any portion of it may result in severe civil and criminal penalties and will be prosecuted to the maximum extent possible under the law YE TT EmbCore Embedded Software amp Modules 13 of 29 UOVS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Get Code Window Protecting Sample Code Click Get Code to show C protected sample code in a new dialog C sample code Product key and Security ID required gt C Protected Code include windows bz include SQFlash PDM h pragma comment lib SQFlash PDM lib int WINAPI WinMain HINSTANCE hInstance HINSTANCE hPrevInstance PSTR IpCmdLine int NShowCmd i const WCHAR PASSWORD L ASAQ5 32TH3 Y37QS ADYP9 F HII CT78N 85VAA const WCHAR SECURE_ID L SID_12345 BOOL bRet FALSE bRet SOFlash Initialize PASSWORD if bRet FALSE MessageBox NULL L Initialize failed NULL NULL return 0 WCHAR szSecurityID 1024 0 bRet
16. sse esse skep n es Ee be ok RE EE 28 ABOUT SE N EE EE EE aa 29 4 of 29 UYS TT EmbCore Embedded Software amp Modules SUSI SQFlash PDM Introduction SUSI SQFlash software package is a flash management package contains utility and API to access Advantech Flash Storages It supports Software Protection Security ID Read Write amp Flash Lock and Life Monitoring S M A R T features Product key protected package provides user a safe environment not only protect application itself but also prevents Security ID not to be read without the same product key while writing Flash Lock function allows user to Lock amp Disable Flash Storage and Unlock by BIOS while booting A locked SQFlash cannot be read by any card reader or boot from other platforms without a BIOS with Unlock feature S M A R T attribute contains Max Average Program and Erase Cycles Power On Time ECC count and Endurance Check User can monitor it directly by SUSI SQFlash utility or implement into application by SUSI SQFlash API Life span detection mechanism can be designed through the information of Endurance Check Benefits a Faster Time to Market The Utility is ready to run without modifications System developers can use it to control the SQFlash without knowing the controller specs of the SQFlash API and sample code ready for software developers to implement flash management mechanism into their applications a Protect Your Intellectual Property
Download Pdf Manuals
Related Search