Teledyne Sierra SAS-SATA User Manual

Sierra SAS/SATA Protocol

Analyzer

SAS/SATA Protocol Suite

STX Software

API Reference Manual

Software Version 5.10

Document Version 3.94

November 2012

Teledyne LeCroy Protocol Solutions Group

Trademarks and Servicemarks:

Teledyne LeCroy, Sierra M6-4, Sierra M6-2, STX A6-4, Sierra M6-1.

Microsoft and Windows are registered trademarks of Microsoft Corporation.

Intel and Pentium are registered trademarks of Intel Corporation.

All other trademarks and registered trademarks are property of their respective owners.

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE
SUBJECT TO CHANGE WITHOUT NOTICE. ALL INFORMATION, EXAMPLES AND
RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE REPRESENTED
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS ARE FULLY RESPONSIBLE FOR
THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE
SET FORTH IN INFORMATION THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED
HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR
LIMITED WARRANTY, CONTACT LeCroy FOR A COPY.

Teledyne LeCroy © 2012. All rights reserved.

This document may be printed and reporduced without additional permission, but all copies
should contain this copyright notice.

WEEE Program

Teledyne LeCroy

3385 Scott Blvd.

Santa Clara, CA 95054

TEL: [phone] (USA and Canada)

TEL: [phone]

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 2

Contents

Introduction ................................................................................................................ 29

API Description ................................................................................................ 29

COM Interfaces Supported ....................................................................... 31

Constants .................................................................................................. 32

Parameters ................................................................................................ 35

API Errors .................................................................................................. 35

How to Use the API .............................................................................................................. 36

Setup your API Application ............................................................................. 36

Initialize Your Application ............................................................................... 37

Set a valid path for the output file of your application ............................ 38

Declare two required objects in main class of your application .............. 38

Create Instances of the two objects just declared in the

main class of your application .................................................................. 39

Finalize initialization by calling “InitializeSystem ()”................................. 40

Connecting to the Board ................................................................................. 40

How to Set/Initialize Connection Points ......................................................... 44

Using Analyzer API .......................................................................................... 46

Initialize a Capture Project Object ............................................................ 47

Create a New Analyzer Capture Project ................................................... 47

Run an Analyzer Capture Project .............................................................. 49

Stop an Analyzer Capture Project ............................................................. 51

Upload and create sample file .................................................................. 52

Open a Saved Capture Project .................................................................. 55

Modifying an Existing Analyzer Project .................................................... 56

Set Trigger Mode/Strategy ...................................................................................................... 56

Add a Trigger Pattern............................................................................................................... 57

Remove a Trigger Pattern ........................................................................................................ 61

Set Capture Mode/ Strategy .................................................................................................... 62

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 3

Add a Capture Pattern ............................................................................................................. 63

Remove a Capture Pattern ...................................................................................................... 66

Exclude/Include Specific Pattern Items ................................................................................... 66

Set Memory Usage Parameters ............................................................................................... 68

Set Output Sample File Path .................................................................................................... 70

Set Port Configuration ............................................................................................................. 71

Summary ................................................................................................... 72

Using Initiator/Host Emulator API Functions .................................................. 73

Initialize an Initiator Capture Project Object ............................................ 74

Create a New Initiator Capture Project .................................................... 74

Run, Stop and Create-Sample for an Initiator Capture Project ................ 75

Open a Saved Initiator Capture Project .................................................... 77

Modify an Initiator Capture Project .......................................................... 78

Add/ Insert a packet in Initiator ............................................................................................... 79

Add/ Insert Events in Initiator.................................................................................................. 81

Add/ Insert an Instruction in Initiator ...................................................................................... 83

Remove/Delete an Inserted Packet ......................................................................................... 84

Remove/Delete an Inserted Event/Instruction ........................................................................ 84

Error Injection on Packets in Initiator ...................................................................................... 85

Summary ................................................................................................... 97

Using Target/Device Emulator API Functions ............................................... 100

Initialize and Create a New Target Emulator Object .............................. 100

Open a Saved Target Emulator ............................................................... 101

Modify an Existing Target Emulator Project ........................................... 101

Modify Pages ......................................................................................................................... 101

Error Injection on Packets of Target Emulator....................................................................... 103

Summary ................................................................................................. 133

Using Trainer ................................................................................................. 139

Create and Setup your API Application................................................... 139

Initialize your API Application ................................................................. 140

Set a valid path for the output file of your application .......................................................... 140

Declare required objects in main class of your application ................................................... 141

Create Instances of the two objects just declared in the main class of your application ...... 141

Finalize the Initialization by calling “InitializeSystem ()”........................................................ 142

Connecting to the Board ......................................................................... 143

Start Trainer ............................................................................................ 144

Stop/ Resume Trainer ............................................................................. 146

Summary ................................................................................................. 147

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 4

How to Navigate through Trace File ............................................................. 148

Load a Trace File and Build View ............................................................ 148

Load a Trace File .................................................................................................................... 148

Build View for Packet Navigation ........................................................................................... 148

Navigate through Trace File .................................................................... 149

Extraction of Packet Information ........................................................................................... 149

Navigate through Packets ...................................................................................................... 152

Filter Packets ........................................................................................... 153

Set Filter Data ........................................................................................................................ 153

Apply Filter ............................................................................................................................ 157

Search/ Find Packets ............................................................................... 157

Summary ................................................................................................. 158

Using CATC API .............................................................................................. 160

Create an SASAnalyzer Object ................................................................ 160

Call the Attach Function .......................................................................... 160

Using Infusion API ......................................................................................... 161

Initialize Sierra Infusion and Connect to Board ...................................... 161

Create a Callback class which inherits from CINFAPINotificationCallback class ........................ 161

Create an object from Callback class and initialize it ............................................................. 162

Initialize the Infusion Library ................................................................................................. 162

Get main objects from Infusion library to work with them ................................................... 162

Get connected devices list ..................................................................................................... 163

Call ConnectFromAPI function to connect to a specified board ............................................ 164

Disconnect from the board .................................................................................................... 168

Run and Stop Scenario ............................................................................ 168

Set port configuration in Infusion .......................................................................................... 168

Specify scenario ..................................................................................................................... 170

StartSession ........................................................................................................................... 170

StopSession ............................................................................................................................ 170

SATA Protocol Suite Device Emulator API Functions ............................... 171

Enabling smart feature set ...................................................................... 171

Enabling Smart Self Test ......................................................................... 171

Enabling Error Logging ............................................................................ 172

Enabling READ DATA returns user data ................................................................................. 172

STCompliance API ......................................................................................... 172

VB Script ................................................................................................................................ 172

STCompliance API Methods .................................................................... 173

Attach .................................................................................................................................... 173

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 5

Detach ................................................................................................................................... 173

Initialize ................................................................................................................................. 174

AddTest .................................................................................................................................. 175

RunCompliance ...................................................................................................................... 175

ChangeGTR03Params ............................................................................................................ 175

ChangeNCQ01Params ............................................................................................................ 176

ChangeNCQ03Params ............................................................................................................ 176

ComplianceTestsEnum ............................................................................ 176

ATAPIMediaTypeEnum ........................................................................... 178

PIO OUT Commands List ......................................................................... 178

DMA IN Commands List .......................................................................... 179

Register DLLs and Setup ..................................................................................................... 180

Visual C++ ...................................................................................................... 180

Import 1 .................................................................................................. 180

Import 2 .................................................................................................. 181

APIHeader.h ............................................................................................ 181

Visual Basic .................................................................................................... 181

Import ..................................................................................................... 181

Project ..................................................................................................... 181

Creating SAS Objects .......................................................................................................... 182

Creating SAS Objects in Trainer Mode .......................................................... 182

Interfaces .............................................................................................................. 183

ISASAPISrvs.................................................................................................... 183

Methods .................................................................................................. 183

HelloAutomation ................................................................................................................... 184

GetSASGeneralServicePtr ...................................................................................................... 184

GetSerialSCSICaptureProjectPtr ............................................................................................ 185

GetSerialSCSIExtractionPtr .................................................................................................... 185

GetTargetEmulEnginePtr ....................................................................................................... 186

GetExerciserEnginePtr ........................................................................................................... 186

StartGeneration ..................................................................................................................... 187

StopGeneration ..................................................................................................................... 188

ResumeGeneration ................................................................................................................ 189

GetGenerationStatus ............................................................................................................. 190

ISerialSCSICaptureProject ............................................................................. 191

Methods .................................................................................................. 191

AddCapturePattern ................................................................................................................ 208

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 6

AddConditionExprPattern ...................................................................................................... 209

AddConditionExprtimerToken ............................................................................................... 211

AddState ................................................................................................................................ 212

CopyState .............................................................................................................................. 212

CopyPasteState ...................................................................................................................... 213

GetProjectType ...................................................................................................................... 214

GetATACommandCapturePatternLBAMode .......................................................................... 214

GetATACommandConditionExprPatternLBAMode ................................................................ 215

GetAvailableHWResource ...................................................................................................... 216

GetCaptureFISType ................................................................................................................ 217

GetCapturePatternCommandSpecType ................................................................................ 218

GetCapturePatternDataOffset ............................................................................................... 219

GetCapturePatternDirection ................................................................................................. 220

GetCapturePatternFilter ........................................................................................................ 221

GetCapturePatternFISDataOffset .......................................................................................... 222

GetCapturePatternId ............................................................................................................. 223

GetCapturePatternIndex ....................................................................................................... 224

GetCapturePatternName ....................................................................................................... 225

GetCapturePatternParameterOptionId ................................................................................. 226

GetCapturePatternParameterOptionName ........................................................................... 227

GetCapturePatternParameterValue ...................................................................................... 228

GetCapturePatternPrimitiveType .......................................................................................... 229

GetCapturePatternProtocolTypeProtocolType ...................................................................... 230

GetCapturePatternSCSICommandType ................................................................................. 231

GetCapturePatternSMPFunctionType ................................................................................... 232

GetCapturePatternSSPFrameType ......................................................................................... 233

GetCapturePatternType ........................................................................................................ 234

GetCaptureStrategy ............................................................................................................... 235

GetConditionCounter ............................................................................................................ 236

GetConditionExpressionTokenType ....................................................................................... 237

GetConditionExpressionType ................................................................................................ 238

GetConditionExprFISType ...................................................................................................... 239

GetConditionExprPatternATAPICommandType..................................................................... 240

GetConditionExprPatternATAPISpecType ............................................................................. 241

GetConditionExprPatternCommandSpecType....................................................................... 242

GetConditionExprPatternDataOffset ..................................................................................... 243

GetConditionExprPatternDirection ........................................................................................ 244

GetConditionExprPatternFISDataOffset ................................................................................ 245

GetConditionExprPatternId ................................................................................................... 246

GetConditionExprPatternIndex ............................................................................................. 247

GetConditionExprPatternName ............................................................................................. 248

GetConditionExprPatternParameterOptionId ....................................................................... 249

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 7

GetConditionExprPatternParameterOptionName ................................................................. 250

GetConditionExprPatternParameterValue ............................................................................ 251

GetConditionExprPatternPrimitiveType ................................................................................ 252

GetConditionExprPatternProtocolTypeProtocolType ............................................................ 253

GetConditionExprPatternSCSICommandType ....................................................................... 254

GetConditionExprPatternSMPFunctionType ......................................................................... 255

GetConditionExprPatternSSPFrameType ............................................................................... 256

GetConditionExprpatternType............................................................................................... 257

GetConditionExprTimerId ...................................................................................................... 258

GetConditionExternalSignalAction ........................................................................................ 259

GetConditionGotoActionStateIndex ...................................................................................... 260

GetConditionTriggerAction .................................................................................................... 261

GetDataCapturePatternProtocolType ................................................................................... 262

GetDataConditionExprPatternProtocolType ......................................................................... 263

GetEntireMemory .................................................................................................................. 263

GetExcludeALIGN ................................................................................................................... 264

GetExcludeCONT ................................................................................................................... 264

GetExcludeIdle ....................................................................................................................... 265

GetExcludeNOTIFY ................................................................................................................. 265

GetExcludeOOBSignals .......................................................................................................... 266

GetExcludePayloadOffset ...................................................................................................... 266

GetExcludeRRDY .................................................................................................................... 267

GetExcludeSYNC .................................................................................................................... 267

GetExcludeXXXX .................................................................................................................... 268

GetExerciserInterface ............................................................................................................ 268

GetExistStateId ...................................................................................................................... 269

GetLastErrorStateId ............................................................................................................... 269

GetNumberOfCapturePatterns .............................................................................................. 270

GetNumberOfCondition ........................................................................................................ 270

GetNumberOfConditionExprToken ....................................................................................... 271

GetNumberOfState ................................................................................................................ 271

GetPermittedPatternDirection .............................................................................................. 272

GetStateActionType ............................................................................................................... 273

GetStateId .............................................................................................................................. 274

GetStateIndex ........................................................................................................................ 274

GetSymbolPatternType ......................................................................................................... 275

GetTimerResolutionMode ..................................................................................................... 276

GetTimerValue ....................................................................................................................... 277

GetTriggerPatternNumOfMatch ............................................................................................ 278

GetTriggerStrategy ................................................................................................................ 278

GetTrunDataPayload ............................................................................................................. 279

GetVendorFISCapturePatternLength ..................................................................................... 280

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 8

GetVendorFISConditionExprPatternLength ........................................................................... 281

HasCapturePatternParameter ............................................................................................... 282

HasConditionExprPatternParameter ..................................................................................... 283

HasSameCaptureingAsState0 ................................................................................................ 284

InsertConditionExprPatternTokenAt ..................................................................................... 284

InsertConditionExprTimerTokenAt ........................................................................................ 286

IsProgrammedTimer .............................................................................................................. 287

IsTriggerSequentialMode....................................................................................................... 287

MoveTriggerPattern .............................................................................................................. 288

New ....................................................................................................................................... 288

Open ...................................................................................................................................... 289

PasteSpecialState .................................................................................................................. 290

PasteState .............................................................................................................................. 291

SetProjectType....................................................................................................................... 292

RemoveAssignedResource ..................................................................................................... 292

RemoveCapturePattern ......................................................................................................... 294

RemoveConditionExprPattern ............................................................................................... 295

RemoveState ......................................................................................................................... 296

Run ........................................................................................................................................ 296

Save ....................................................................................................................................... 297

SetAddressFrameCapturePattern .......................................................................................... 298

SetAddressFrameConditionExprPattern ................................................................................ 299

SetATACommandCapturePattern .......................................................................................... 300

SetATACommandCapturePatternLBAMode .......................................................................... 301

SetATACommandConditionExprPattern ................................................................................ 302

SetATACommandConditionExprPatternLBAMode ................................................................ 303

SetCapturePatternDataOffset................................................................................................ 304

SetCapturePatternDirection .................................................................................................. 305

SetCapturePatternFilter ......................................................................................................... 306

SetCapturePatternFISDataOffset ........................................................................................... 307

SetCapturePatternParameterValue ....................................................................................... 308

SetCapturePatternParameterValueByOptionId ..................................................................... 309

SetCapturePatternSCSICommandType .................................................................................. 310

SetCaptureStrategy................................................................................................................ 311

SetConditionCounter ............................................................................................................. 312

SetConditionExprPatternATAPICommandType ..................................................................... 313

SetConditionExprPatternATAPISpecType .............................................................................. 314

SetConditionExprPatternDataOffset ...................................................................................... 315

SetConditionExprPatternDirection ........................................................................................ 316

SetConditionExprPatternFISDataOffset ................................................................................. 317

SetConditionExprPatternParameterLength ........................................................................... 318

SetConditionExprPatternParameterValue ............................................................................. 319

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 9

SetConditionExprPatternParameterValueByOptionId ........................................................... 320

SetConditionExprPatternSCSICommandType ........................................................................ 321

SetConditionExprTimerId ....................................................................................................... 322

SetConditionExternalSignalAction ......................................................................................... 323

SetConditionGotoActionStateIndex ....................................................................................... 324

SetConditionTriggerAction .................................................................................................... 325

SetDataCapturePattern ......................................................................................................... 326

SetDataConditionExprPattern ............................................................................................... 327

SetExcludeALIGN ................................................................................................................... 328

SetExcludeCONT .................................................................................................................... 329

SetExcludeIdle ....................................................................................................................... 330

SetExcludeNOTIFY.................................................................................................................. 331

SetExcludeOOBSignals ........................................................................................................... 332

SetExcludeRRDY ..................................................................................................................... 333

SetExcludeSYNC ..................................................................................................................... 334

SetExcludeXXXX ..................................................................................................................... 335

SetFISCapturePattern ............................................................................................................ 336

SetFISConditionExprPattern .................................................................................................. 337

SetPrimitiveTypeCapturePattern ........................................................................................... 338

SetPrimitiveTypeConditionExprPattern ................................................................................. 339

SetProgrammedTimer ........................................................................................................... 340

SetProtocolErrorCapturePattern ........................................................................................... 341

SetProtocolErrorConditionExprPattern ................................................................................. 342

SetSameCaptureingAsState0 ................................................................................................. 343

SetSCSICommandCapturePattern .......................................................................................... 344

SetSCSICommandConditionExprPattern ................................................................................ 345

SetSMPFrameCapturePattern ............................................................................................... 346

SetSMPFrameConditionExprPattern...................................................................................... 347

SetSSPFrameCapturePattern ................................................................................................. 348

SetSSPFrameConditionExprPattern ....................................................................................... 349

SetStateActionType ............................................................................................................... 350

SetSymbolPatternType .......................................................................................................... 351

SetTimerResolutionMode ...................................................................................................... 352

SetTimerValue ....................................................................................................................... 353

SetTriggerPatternNumOfMatch............................................................................................. 354

SetTriggerSequentialMode .................................................................................................... 355

SetTriggerStrategy ................................................................................................................. 356

SetTrunDataPayload .............................................................................................................. 357

SetVendorFISCapturePatternLength ..................................................................................... 358

SetVendorFISConditionExprPatternLength ............................................................................ 359

UpdateHardwareResource .................................................................................................... 360

SetDeviceType ....................................................................................................................... 361

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 10

GetDeviceType....................................................................................................................... 362

SetTahoeExternalTrigInType .................................................................................................. 362

GetTahoeExternalTrigInType ................................................................................................. 363

SetTahoeExternalTrigOutSetting ........................................................................................... 363

GetTahoeExternalTrigOutSetting ........................................................................................... 364

Properties ................................................................................................ 365

ISASGeneralService ....................................................................................... 367

Methods .................................................................................................. 367

Attach .................................................................................................................................... 369

Detach ................................................................................................................................... 370

GetLayerIndex........................................................................................................................ 370

GetLayerName ....................................................................................................................... 371

HalAnalyzerStop .................................................................................................................... 371

InitializeSystem ...................................................................................................................... 372

IsHWRunning ......................................................................................................................... 372

IsExerciserRunning ................................................................................................................. 373

IsHWTrigged .......................................................................................................................... 373

ShutdownSystem ................................................................................................................... 373

GetNumberOfAvailableATACommands ................................................................................. 374

GetATACommandAttribute ................................................................................................... 374

GetNumberOfAvailableBusCondition .................................................................................... 375

GetNumberOfAvailableFIS ..................................................................................................... 375

GetFISAttribute ...................................................................................................................... 376

GetNumberOfSupportedHWProtocolErrors .......................................................................... 376

GetSupportedHWProtocolError ............................................................................................ 377

GetSampleFileProperties ....................................................................................................... 378

GetPErrorAttribute ................................................................................................................ 379

GetNumberOfAvailableSCSICommandStatus ........................................................................ 379

GetSCSICommandStatusAttribute ......................................................................................... 380

GetNumberOfAvailablePErrors .............................................................................................. 380

GetNumberOfSupportedPortConfiguration .......................................................................... 381

GetSupportedPortConfiguration ........................................................................................... 382

SelectNetworkAdapter .......................................................................................................... 383

IExerciserEngine ............................................................................................ 384

Default Interface Methods ..................................................................... 384

AddProtocolErrorToPacket .................................................................................................... 395

AssignLable ............................................................................................................................ 396

ChangeLable .......................................................................................................................... 396

DeleteAll ................................................................................................................................ 397

DeleteInstruction ................................................................................................................... 397

DeletePacket .......................................................................................................................... 398

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 11

ExpandSATASelfTestInstructionField ..................................................................................... 399

GetEnablePatternGenerator .................................................................................................. 399

GetAffiliationType .................................................................................................................. 400

GetAutomaticAction .............................................................................................................. 401

GetAutoUpdateProperties ..................................................................................................... 402

GetDataInProperties .............................................................................................................. 403

GetDelayInstructionTime ....................................................................................................... 404

GetDelayInstructionTimeUnit ................................................................................................ 405

GetDestinationAddress .......................................................................................................... 406

GetEnableFirstBurst ............................................................................................................... 407

GetEnableRateMatching ........................................................................................................ 408

GetExternalTrig ...................................................................................................................... 409

GetFieldData .......................................................................................................................... 410

GetFieldDescription ............................................................................................................... 411

GetFieldID .............................................................................................................................. 412

GetFieldLength ...................................................................................................................... 413

GetFieldName ........................................................................................................................ 414

GetFieldOptionDescription .................................................................................................... 415

GetFieldStream ...................................................................................................................... 416

GetGoToInstructionLableId ................................................................................................... 417

GetIdentifyFrameTypeError ................................................................................................... 417

GetIfDeviceTypeInstrType ..................................................................................................... 418

GetIfInstructionCheckConditionAttr ...................................................................................... 419

GetIfInstructionCondition ...................................................................................................... 420

GetIfInstructionConditionDes ................................................................................................ 420

GetIfInstructionConditionProperties ..................................................................................... 421

GetIfInstructionLableId .......................................................................................................... 421

GetIfInstructionNumberOfCondition ..................................................................................... 422

GetIfLastFrameInstrDeviceType ............................................................................................ 422

GetIfLastFrameInstrFrameType ............................................................................................. 423

GetIfLastFrameInstrProtocolType .......................................................................................... 423

GetIfLastHandshakeInstrType ................................................................................................ 424

GetIfPayloadInstrData ........................................................................................................... 425

GetIfPayloadInstrLength ........................................................................................................ 426

GetIfPayloadInstrMatch......................................................................................................... 427

GetInstructionProerties ......................................................................................................... 428

GetInstructionType ................................................................................................................ 428

GetLableNote ......................................................................................................................... 429

GetLableProperties ................................................................................................................ 429

GetLogicalUnitNumber .......................................................................................................... 430

GetLoopInstructionCounter ................................................................................................... 431

GetLoopInstructionType ........................................................................................................ 431

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 12

GetNumberOfLables .............................................................................................................. 432

GetOOBInstrBurstTime .......................................................................................................... 432

GetOOBInstrCount ................................................................................................................. 433

GetOOBInstrIdleTime ............................................................................................................ 434

GetOOBInstrIgnore ................................................................................................................ 435

GetOOBInstrNegationTime .................................................................................................... 436

GetOOBInstrSATAPortSelectionT1 ......................................................................................... 436

GetOOBInstrSATAPortSelectionT2 ......................................................................................... 437

GetOOBInstructionSyncState................................................................................................. 437

GetOOBInstructionType ........................................................................................................ 438

GetPacketData ....................................................................................................................... 439

GetPacketIndex...................................................................................................................... 440

GetPacketLableProperties ..................................................................................................... 441

GetPacketProperties .............................................................................................................. 442

GetPacketRetryNumber......................................................................................................... 443

GetPrimitiveInstructionCount ................................................................................................ 444

GetPrimitiveInstructionType ................................................................................................. 444

GetPrimitiveInstructionValue ................................................................................................ 445

GetProtocolErrorNumberOfPacket ........................................................................................ 445

GetProtocolErrorOfPacket ..................................................................................................... 446

GetSATAPowMngInstructionType ......................................................................................... 446

GetSATASelfTestFieldDataToDBId ......................................................................................... 447

GetSATASelfTestInstructionFieldAbbr ................................................................................... 448

GetSATASelfTestInstructionFieldData ................................................................................... 449

GetSATASelfTestInstructionFieldDescription ......................................................................... 450

GetSATASelfTestInstructionFieldID........................................................................................ 450

GetSATASelfTestInstructionFieldLength ................................................................................ 451

GetSATASelfTestInstructionFieldName ................................................................................. 451

GetSATASelfTestInstructionFieldOptionDescription.............................................................. 452

GetSATASelfTestInstructionFieldStream ............................................................................... 453

GetSATASelfTestInstructionMaxFieldLength ......................................................................... 454

GetSATASelfTestInstructionMinFieldLength .......................................................................... 454

GetSATASelfTestInstructionProperties .................................................................................. 455

GetSATASoftResetInstructionPort ......................................................................................... 456

GetSATAWakeupInstructionOOBType ................................................................................... 456

GetSyntaxErrorLineNumber .................................................................................................. 457

GetTaskAttribute ................................................................................................................... 457

GetTotalPacketCount............................................................................................................. 458

GetTotalPacketInLayer .......................................................................................................... 458

GetTransportPacketProtocolType ......................................................................................... 459

GetTriggerSource ................................................................................................................... 459

GetWaitForHandshake .......................................................................................................... 460

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 13

GetWaitForInstructionLableId ............................................................................................... 460

GetWaitForInstructionTimeExpiration .................................................................................. 461

HasSpecifiedProtocolError ..................................................................................................... 462

InsertInstruction .................................................................................................................... 462

InsertPacket ........................................................................................................................... 463

InsertPacketByData ............................................................................................................... 464

IsReadCommand .................................................................................................................... 465

IsSATASelfTestDataPayloadField ........................................................................................... 465

IsSATASelfTestInstructionFieldExpandable ............................................................................ 466

IsSATASelfTestInstructionFieldExpanded .............................................................................. 466

IsWriteCommand ................................................................................................................... 467

SetEnablePatternGenerator .................................................................................................. 467

RemoveAllProtocolErrorOfPacket ......................................................................................... 468

RemoveLable ......................................................................................................................... 468

Reset ...................................................................................................................................... 469

SetAffiliationType .................................................................................................................. 469

SetAutomaticAction ............................................................................................................... 470

SetAutoUpdateProperties ..................................................................................................... 471

SetDataBlock .......................................................................................................................... 472

SetDataInProperties .............................................................................................................. 473

SetDelayInstructionTime ....................................................................................................... 474

SetDelayInstructionTimeUnit ................................................................................................ 474

SetDestinationAddress .......................................................................................................... 475

SetEnableFirstBurst ............................................................................................................... 476

SetEnableRateMatching ........................................................................................................ 477

SetExternalTrig ...................................................................................................................... 478

SetField .................................................................................................................................. 479

SetFieldByOption ................................................................................................................... 480

SetFieldData .......................................................................................................................... 481

SetFieldDataToDBId ............................................................................................................... 482

SetGoToInstructionLableId .................................................................................................... 483

SetIdentifyFrameTypeError ................................................................................................... 483

SetIfDeviceTypeInstrType ...................................................................................................... 484

SetIfInstructionCheckConditionAttr....................................................................................... 485

SetIfInstructionCondition ...................................................................................................... 486

SetIfInstructionLableId .......................................................................................................... 486

SetIfInstructionCondition ...................................................................................................... 487

SetIfLastFrameInstrDeviceType ............................................................................................. 488

SetIfLastFrameInstrFrameType .............................................................................................. 488

SetIfLastFrameInstrProtocolType .......................................................................................... 489

SetIfLastHandshakeInstrType ................................................................................................ 489

SetIfPayloadInstrData ............................................................................................................ 490

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 14

SetIfPayloadInstrLength ......................................................................................................... 491

SetIfPayloadInstrMatch ......................................................................................................... 492

SetLogicalUnitNumber ........................................................................................................... 493

SetLoopInstructionCounter ................................................................................................... 494

SetLoopInstructionType ......................................................................................................... 494

SetOOBInstrBurstTime ........................................................................................................... 495

SetOOBInstrCount ................................................................................................................. 496

SetOOBInstrIdleTime ............................................................................................................. 497

SetOOBInstrIgnore ................................................................................................................. 498

SetOOBInstrNegationTime .................................................................................................... 499

SetOOBInstrSATAPortSelectionT1 ......................................................................................... 499

SetOOBInstrSATAPortSelectionT2 ......................................................................................... 500

SetOOBInstructionSyncState ................................................................................................. 500

SetOOBInstructionType ......................................................................................................... 501

SetPacketRetryNumber ......................................................................................................... 502

SetPrimitiveInstructionCount ................................................................................................ 503

SetPrimitiveInstructionType .................................................................................................. 503

SetPrimitiveInstructionValue ................................................................................................. 504

SetSATAPowMngInstructionType .......................................................................................... 504

SetSATASelfTestFieldDataToDBId .......................................................................................... 505

SetSATASelfTestInstructionField ............................................................................................ 506

SetSATASelfTestInstructionFieldByOption ............................................................................. 506

SetSATASelfTestInstructionFieldData .................................................................................... 507

SetSATASoftResetInstructionPort .......................................................................................... 508

SetSATAWakeupInstructionOOBType ................................................................................... 509

SetTaskAttribute .................................................................................................................... 510

SetTriggerSource ................................................................................................................... 511

SetWaitForHandshake ........................................................................................................... 512

SetWaitForInstructionLableId ................................................................................................ 513

SetWaitForInstructionTimeExpiration ................................................................................... 514

SetCurrentProgramId............................................................................................................. 515

GetCurrentProgramId ............................................................................................................ 516

Properties ................................................................................................ 517

Error Injection Interface Methods .......................................................... 522

ErInjGetCodeViolationAndDisparityErrorAttribute ................................................................ 531

ErInjGetCodeViolationError ................................................................................................... 532

ErInjGetCodeViolationOnSATAPrimitive ................................................................................ 533

ErInjGetCRCError ................................................................................................................... 534

ErInjGetDelayResponseToHold .............................................................................................. 535

ErInjGetDisparityError ........................................................................................................... 536

ErInjGetDisparityErrorOnSATAPrimitive ................................................................................ 537

ErInjGetDonotCheckCredit .................................................................................................... 538

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 15

ErInjGetEOFError ................................................................................................................... 539

ErInjGetFillByteForReservedField .......................................................................................... 540

ErInjGetFrameErrorType ........................................................................................................ 541

ErInjGetFrameInvalidField ..................................................................................................... 542

ErInjGetFrameLengthError .................................................................................................... 543

ErInjGetHandshakeError ........................................................................................................ 544

ErInjGetIgnoreXRDYorRRDY ................................................................................................... 545

ErInjGetInsertedFrameAttribute............................................................................................ 546

ErInjGetInsertPrimitive .......................................................................................................... 547

ErInjGetInvalidFieldOfFrameAttribute ................................................................................... 548

ErInjGetNoWTRM .................................................................................................................. 549

ErInjGetNumberOfFieldsOfFrame ......................................................................................... 550

ErInjGetOmitFrameFromSequence ....................................................................................... 551

ErInjGetSendDelayToSendHandshake ................................................................................... 552

ErInjGetSendingFrameDelay .................................................................................................. 553

ErInjGetSOFError ................................................................................................................... 554

ErInjSetCodeViolationAndDisparityErrorAttribute ................................................................ 555

ErInjSetCodeViolationError .................................................................................................... 556

ErInjSetCodeViolationOnSATAPrimitive ................................................................................ 557

ErInjSetCRCError .................................................................................................................... 558

ErInjSetDelayResponseToHold .............................................................................................. 559

ErInjSetDisparityError ............................................................................................................ 560

ErInjSetDisparityErrorOnSATAPrimitive ................................................................................. 561

ErInjSetDonotCheckCredit ..................................................................................................... 562

ErInjSetEOFError .................................................................................................................... 563

ErInjSetFillByteForReservedField ........................................................................................... 564

ErInjSetFrameErrorType ........................................................................................................ 565

ErInjSetFrameInvalidField ...................................................................................................... 566

ErInjSetFrameLengthError ..................................................................................................... 567

ErInjSetHandshakeError ........................................................................................................ 568

ErInjSetIgnoreXRDYorRRDY ................................................................................................... 569

ErInjSetInsertedFrameAttribute ............................................................................................ 570

ErInjSetInsertPrimitive ........................................................................................................... 571

ErInjSetNoWTRM ................................................................................................................... 572

ErInjSetOmitFrameFromSequence ........................................................................................ 573

ErInjSetSendDelayToSendHandshake .................................................................................... 574

ErInjSetSendingFrameDelay .................................................................................................. 575

ErInjSetSOFError .................................................................................................................... 576

GetCloseBreakCount .............................................................................................................. 577

GetCloseDoneType ................................................................................................................ 578

GetCloseSequenseType ......................................................................................................... 579

GetIdentifyFrameCodeViolationAndDisparityErrorAttribute ................................................ 580

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 16

GetIdentifyFrameCodeViolationError .................................................................................... 581

GetIdentifyFrameCRCError .................................................................................................... 582

GetIdentifyFrameDisparityError ............................................................................................ 583

GetIdentifyFrameEOAFError .................................................................................................. 584

GetIdentifyFrameFrameLengthError ..................................................................................... 585

GetIdentifyFrameSOAFError .................................................................................................. 586

GetIncomingErrorAttribute ................................................................................................... 587

GetIncomingOpenResponse .................................................................................................. 588

GetOutGoingErrorAttribute ................................................................................................... 589

GetOutGoingErrorSMPFunction ............................................................................................ 590

GetOutGoingOpenFrameCodeVioaltionError ........................................................................ 591

GetOutGoingOpenFrameCodeViolationAndDisparityErrorAttribute ..................................... 592

GetOutGoingOpenFrameCRCError ........................................................................................ 593

GetOutGoingOpenFrameDisparityError ................................................................................ 594

GetOutGoingOpenFrameEOAFError ...................................................................................... 595

GetOutGoingOpenFrameFarmeLengthError ......................................................................... 596

GetOutGoingOpenFrameInvalidFields ................................................................................... 597

GetOutGoingOpenFrameSOAFError ...................................................................................... 598

GetOutGoingOpenFrameTypeError ....................................................................................... 599

GetRespondingCloseConnection ........................................................................................... 600

IsDefineCloseConnection ....................................................................................................... 601

IsDefineOutgoingOpenResponse ........................................................................................... 602

SetCloseBreakCount .............................................................................................................. 603

SetCloseDoneType ................................................................................................................. 604

SetCloseSequenseType .......................................................................................................... 605

SetDefineCloseConnection .................................................................................................... 606

SetDefineOutgoingOpenResponse ........................................................................................ 607

SetIdentifyFrameCodeViolationAndDisparityErrorAttribute ................................................. 608

SetIdentifyFrameCodeViolationError .................................................................................... 609

SetIdentifyFrameCRCError ..................................................................................................... 610

SetIdentifyFrameDisparityError ............................................................................................. 611

SetIdentifyFrameEOAFError .................................................................................................. 612

SetIdentifyFrameFrameLengthError ...................................................................................... 613

SetIdentifyFrameSOAFError .................................................................................................. 614

SetIncomingErrorAttribute .................................................................................................... 615

SetIncomingOpenResponse ................................................................................................... 616

SetOutGoingErrorAttribute ................................................................................................... 617

SetOutGoingErrorSMPFunction ............................................................................................. 618

SetOutGoingOpenFrameCodeVioaltionError ......................................................................... 619

SetOutGoingOpenFrameCodeViolationAndDisparityErrorAttribute ..................................... 620

SetOutGoingOpenFrameCRCError ......................................................................................... 621

SetOutGoingOpenFrameDisparityError ................................................................................. 622

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 17

SetOutGoingOpenFrameEOAFError....................................................................................... 623

SetOutGoingOpenFrameFarmeLengthError .......................................................................... 624

SetOutGoingOpenFrameInvalidFields.................................................................................... 625

SetOutGoingOpenFrameSOAFError ....................................................................................... 626

SetOutGoingOpenFrameTypeError ....................................................................................... 627

SetRespondingCloseConnection ............................................................................................ 628

ITargetEmulEngine ........................................................................................ 629

Methods .................................................................................................. 629

SetIdentifyDeviceFieldStream ............................................................................................... 632

GetIdentifyDeviceFieldStream ............................................................................................... 633

SetFieldStream....................................................................................................................... 634

GetFieldStream ...................................................................................................................... 635

SetFieldData .......................................................................................................................... 636

GetFieldData .......................................................................................................................... 637

ActiveDevice .......................................................................................................................... 637

GetATACapacity ..................................................................................................................... 638

GetCapacity ........................................................................................................................... 639

SetAsDefault .......................................................................................................................... 639

Save ....................................................................................................................................... 640

Load ....................................................................................................................................... 640

SetCOMINITNegationTime..................................................................................................... 641

GetCOMINITNegationTime .................................................................................................... 641

SetCOMINITBurstCount ......................................................................................................... 642

GetCOMINITBurstCount ........................................................................................................ 642

SetCOMINITBurstTime ........................................................................................................... 643

GetCOMINITBurstTime .......................................................................................................... 643

SetCOMINITIdleTime ............................................................................................................. 644

GetCOMINITIdleTime ............................................................................................................. 644

SetCOMSASBurstTime ........................................................................................................... 645

GetCOMSASBurstTime ........................................................................................................... 645

SetCOMSASIdleTime .............................................................................................................. 646

GetCOMSASIdleTime ............................................................................................................. 646

SetCOMSASNegationTime ..................................................................................................... 647

GetCOMSASNegationTime .................................................................................................... 647

SetCOMSASBurstCount .......................................................................................................... 648

GetCOMSASBurstCount ......................................................................................................... 648

SetCOMWAKEBurstTime ....................................................................................................... 649

GetCOMWAKEBurstTime ....................................................................................................... 649

SetCOMWAKEIdleTime .......................................................................................................... 650

GetCOMWAKEIdleTime ......................................................................................................... 650

SetCOMWAKENegationTime ................................................................................................. 651

GetCOMWAKENegationTime................................................................................................. 651

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 18

SetCOMWAKEBurstCount ...................................................................................................... 652

GetCOMWAKEBurstCount ..................................................................................................... 652

SetIgnoreIncomingCOMWAKE ............................................................................................... 653

GetIgnoreIncomingCOMWAKE .............................................................................................. 653

SetIgnoreIncomingCOMINIT .................................................................................................. 654

GetIgnoreIncomingCOMINT .................................................................................................. 654

SetIgnoreIncomingCOMSAS................................................................................................... 655

GetIgnoreIncomingCOMSAS .................................................................................................. 655

SetNumberOfWritableAreas .................................................................................................. 656

GetNumberOfWritableAreas ................................................................................................. 656

SetAddressOfWritableArea.................................................................................................... 657

GetAddressOfWritableArea ................................................................................................... 658

AddUserDefineCommand ...................................................................................................... 659

DeleteUserDefineCommand .................................................................................................. 660

SetUserDefineCommand ....................................................................................................... 661

SetMuxingEnabled ................................................................................................................. 662

GetMuxingEnabled ................................................................................................................ 662

GetDeviceType....................................................................................................................... 663

SetDeviceType ....................................................................................................................... 663

SetPortSpeedByIndex ............................................................................................................ 664

GetPortSpeedByIndex............................................................................................................ 665

Properties ................................................................................................ 666

Error Injection Interface Methods .......................................................... 670

ErInjGetCodeViolationAndDisparityErrorAttribute ................................................................ 687

ErInjGetCodeViolationError ................................................................................................... 688

ErInjGetCodeViolationOnSATAPrimitive ................................................................................ 689

ErInjGetCRCError ................................................................................................................... 690

ErInjGetDelayResponseToHold .............................................................................................. 691

ErInjGetDisparityError ........................................................................................................... 692

ErInjGetDisparityErrorOnSATAPrimitive ................................................................................ 693

ErInjGetDonotCheckCredit .................................................................................................... 694

ErInjGetEOFError ................................................................................................................... 695

ErInjGetFillByteForReservedField .......................................................................................... 696

ErInjGetFrameErrorType ........................................................................................................ 697

ErInjGetFrameInvalidField ..................................................................................................... 698

ErInjGetFrameLengthError .................................................................................................... 699

ErInjGetHandshakeError ........................................................................................................ 700

ErInjGetIgnoreXRDYorRRDY ................................................................................................... 701

ErInjGetInsertedFrameAttribute............................................................................................ 702

ErInjGetInsertPrimitive .......................................................................................................... 703

ErInjGetInvalidFieldOfFrameAttribute ................................................................................... 704

ErInjGetNoWTRM .................................................................................................................. 705

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 19

ErInjGetNumberOfFieldsOfFrame ......................................................................................... 706

ErInjGetOmitFrameFromSequence ....................................................................................... 707

ErInjGetSendDelayToSendHandshake ................................................................................... 708

ErInjGetSendingFrameDelay .................................................................................................. 709

ErInjGetTerminateRecievingFrameAttribute ......................................................................... 710

ErInjGetSOFError ................................................................................................................... 711

ErInjSetCodeViolationAndDisparityErrorAttribute ................................................................ 712

ErInjSetCodeViolationError .................................................................................................... 713

ErInjSetCodeViolationOnSATAPrimitive ................................................................................ 714

ErInjSetCRCError .................................................................................................................... 715

ErInjSetDelayResponseToHold .............................................................................................. 716

ErInjSetDisparityError ............................................................................................................ 717

ErInjSetDisparityErrorOnSATAPrimitive ................................................................................. 718

ErInjSetDonotCheckCredit ..................................................................................................... 719

ErInjSetEOFError .................................................................................................................... 720

ErInjSetFillByteForReservedField ........................................................................................... 721

ErInjSetFrameErrorType ........................................................................................................ 722

ErInjSetFrameInvalidField ...................................................................................................... 723

ErInjSetFrameLengthError ..................................................................................................... 724

ErInjSetHandshakeError ........................................................................................................ 725

ErInjSetIgnoreXRDYorRRDY ................................................................................................... 726

ErInjSetInsertedFrameAttribute ............................................................................................ 727

ErInjSetInsertPrimitive ........................................................................................................... 728

ErInjSetNoWTRM ................................................................................................................... 729

ErInjSetOmitFrameFromSequence ........................................................................................ 730

ErInjSetSendDelayToSendHandshake .................................................................................... 731

ErInjSetSendingFrameDelay .................................................................................................. 732

ErInjSetSOFError .................................................................................................................... 733

ErInjSetTerminateRecievingFrameAttribute .......................................................................... 734

ErInjCmnSetErrorGenerationRate ......................................................................................... 735

ErInjCmnGetErrorGenerationRate ......................................................................................... 736

ErInjCmnSetSpeedNegotiationFailureAttrbiute ..................................................................... 737

ErInjCmnGetSpeedNegotiationFailureAttrbiute .................................................................... 738

ErInjCmnSetBufferStarvation ................................................................................................. 738

ErInjCmnGetBufferStarvation ................................................................................................ 739

ErInjCmnSetNonReleaseOfLink .............................................................................................. 739

ErInjCmnGetNonReleaseOfLink ............................................................................................. 740

ErInjCmnSetLinkResetTimerAfterLinkEnable ......................................................................... 740

ErInjCmnGetLinkResetTimerAfterLinkEnable ........................................................................ 741

ErInjCmnSetHardResetCounterAfterPHYReady ..................................................................... 741

ErInjCmnGetHardResetCounterAfterPHYReady .................................................................... 742

ErInjCmnSetDonotCheckCredit .............................................................................................. 742

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 20

ErInjCmnGetDonotCheckCredit ............................................................................................. 743

ErInjCmnSetCRCError............................................................................................................. 743

ErInjCmnGetCRCError ............................................................................................................ 744

ErInjCmnSetCodeViolationError ............................................................................................ 744

ErInjCmnGetCodeViolationError ............................................................................................ 745

ErInjCmnSetDisparityError ..................................................................................................... 745

ErInjCmnGetDisparityError .................................................................................................... 746

ErInjCmnSetCodeViolationAndDisparityErrorAttribute ......................................................... 746

ErInjCmnGetCodeViolationAndDisparityErrorAttribute ........................................................ 747

ErInjCmnSetEOFError............................................................................................................. 748

ErInjCmnGetEOFError ............................................................................................................ 748

ErInjCmnSetSOFError ............................................................................................................. 749

ErInjCmnGetSOFError ............................................................................................................ 749

ErInjCmnSetNoWTRM ........................................................................................................... 750

ErInjCmnGetNoWTRM ........................................................................................................... 750

ErInjCmnSetIgnoreXRDYorRRDY ............................................................................................ 751

ErInjCmnGetIgnoreXRDYorRRDY ........................................................................................... 751

ErInjCmnSetDelayResponseToHold ....................................................................................... 752

ErInjCmnGetDelayResponseToHold ...................................................................................... 752

ErInjCmnSetInsertPrimitive ................................................................................................... 753

ErInjCmnGetInsertPrimitive ................................................................................................... 754

ErInjCmnSetFillByteForReservedField.................................................................................... 755

ErInjCmnGetFillByteForReservedField ................................................................................... 755

ErInjCmnSetFrameLengthError .............................................................................................. 756

ErInjCmnGetFrameLengthError ............................................................................................. 757

ErInjIdefSetCRCError .............................................................................................................. 758

ErInjIdefGetCRCError ............................................................................................................. 758

ErInjIdefSetCodeViolationError ............................................................................................. 759

ErInjIdefGetCodeViolationError ............................................................................................. 759

ErInjIdefSetDisparityError ...................................................................................................... 760

ErInjIdefGetDisparityError ..................................................................................................... 760

ErInjIdefSetCodeViolationAndDisparityErrorAttribute .......................................................... 761

ErInjIdefGetCodeViolationAndDisparityErrorAttribute ......................................................... 761

ErInjIdefSetEOAFError ........................................................................................................... 762

ErInjIdefGetEOAFError ........................................................................................................... 762

ErInjIdefSetSOAFError ........................................................................................................... 763

ErInjIdefGetSOAFError ........................................................................................................... 763

ErInjIdefSetSendIdentify ........................................................................................................ 764

ErInjIdefGetSendIdentify ....................................................................................................... 764

ErInjIdefSetNumberOfSendingIDENTIFYAfterPHYEnable ...................................................... 765

ErInjIdefGetNumberOfSendingIDENTIFYAfterPHYEnable ...................................................... 765

ErInjIdefSetDelayFromPHYEnableToStartIdentification ........................................................ 766

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 21

ErInjIdefGetDelayFromPHYEnableToStartIdentification ........................................................ 766

ErInjIdefSetFrameTypeError .................................................................................................. 767

ErInjIdefGetFrameTypeError ................................................................................................. 767

ErInjConMgnSetErrorOnCloseConnection ............................................................................. 768

ErInjConMgnGetErrorOnCloseConnection ............................................................................ 768

ErInjConMgnSetErrorOnRespondingToCloseConnection ...................................................... 769

ErInjConMgnGetErrorOnRespondingToCloseConnection ...................................................... 770

ErInjConMgnSetErrorOnCloseSequence ................................................................................ 771

ErInjConMgnGetErrorOnCloseSequence ............................................................................... 772

ErInjConMgnSetIncomingOpenFrameErrorAttribute ............................................................ 773

ErInjConMgnGetIncomingOpenFrameErrorAttribute ............................................................ 773

ErInjConMgnSetOutgoingOpenFrameErrorAttribute ............................................................ 774

ErInjConMgnGetOutgoingOpenFrameErrorAttribute ............................................................ 774

ErInjConMgnSetOutGoingOpenFrameInvalidFields ............................................................... 775

ErInjConMgnGetOutGoingOpenFrameInvalidFields .............................................................. 775

ErInjConMgnSetDelayResponseToIncomingOpenFrame ....................................................... 776

ErInjConMgnGetDelayResponseToIncomingOpenFrame ...................................................... 776

ErInjConMgnSetResponseTypeToIncomingOpenFrame ........................................................ 777

ErInjConMgnGetResponseTypeToIncomingOpenFrame ....................................................... 777

ErInjConMgnSetCRCError ...................................................................................................... 778

ErInjConMgnGetCRCError ...................................................................................................... 778

ErInjConMgnSetSOAFError .................................................................................................... 779

ErInjConMgnGetSOAFError ................................................................................................... 779

ErInjConMgnSetEOAFError .................................................................................................... 780

ErInjConMgnGetEOAFError ................................................................................................... 780

ErInjConMgnSetFarmeLengthError ....................................................................................... 781

ErInjConMgnGetFarmeLengthError ....................................................................................... 781

ErInjConMgnSetDisparityError .............................................................................................. 782

ErInjConMgnGetDisparityError .............................................................................................. 782

ErInjConMgnSetCodeVioaltionError ...................................................................................... 783

ErInjConMgnGetCodeVioaltionError ..................................................................................... 783

ErInjConMgnSetCodeViolationAndDisparityErrorAttribute ................................................... 784

ErInjConMgnGetCodeViolationAndDisparityErrorAttribute .................................................. 784

ErInjConMgnSetFrameTypeError ........................................................................................... 785

ErInjConMgnGetFrameTypeError .......................................................................................... 785

ErInjSetSCSICommandGenerateError .................................................................................... 786

ErInjGetSCSICommandGenerateError ................................................................................... 787

ErInjSetSCSICommandCheckConditionErrorAttribute ........................................................... 788

ErInjGetSCSICommandCheckConditionErrorAttribute .......................................................... 789

ErInjSetSCSICommandFrameOutGoingErrorAttribute ........................................................... 790

ErInjGetSCSICommandFrameOutGoingErrorAttribute .......................................................... 791

ErInjSetSCSICommandFrameInComingErrorAttribute ........................................................... 792

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 22

ErInjGetSCSICommandFrameInComingErrorAttribute .......................................................... 793

ErInjSetSMPCommandGenerateError ................................................................................... 794

ErInjGetSMPCommandGenerateError ................................................................................... 795

ErInjSetSMPCommandFunctionResultErrorType ................................................................... 796

ErInjGetSMPCommandFunctionResultErrorType .................................................................. 797

ErInjSetSMPCommandFrameOutGoingErrorAttribute .......................................................... 798

ErInjGetSMPCommandFrameOutGoingErrorAttribute.......................................................... 799

ErInjSetSMPCommandFrameInComingErrorAttribute .......................................................... 800

ErInjGetSMPCommandFrameInComingErrorAttribute .......................................................... 801

ErInjSetTskMgnCommandGenerateError .............................................................................. 802

ErInjGetTskMgnCommandGenerateError ............................................................................. 803

ErInjSetTskMgnCommandErrorResponseType ...................................................................... 804

ErInjGetTskMgnCommandErrorResponseType ..................................................................... 805

ErInjSetTskMgnCommandFrameOutGoingErrorAttribute ..................................................... 806

ErInjGetTskMgnCommandFrameOutGoingErrorAttribute .................................................... 807

ErInjSetTskMgnCommandFrameInComingErrorAttribute ..................................................... 808

ErInjGetTskMgnCommandFrameInComingErrorAttribute .................................................... 809

ErInjSetSTPCommandGenerateError ..................................................................................... 810

ErInjGetSTPCommandGenerateError .................................................................................... 811

ErInjSetSTPCommandErrorResponseType ............................................................................. 812

ErInjGetSTPCommandErrorResponseType ............................................................................ 813

ErInjSetSTPCommandFrameOutGoingErrorAttribute ............................................................ 814

ErInjGetSTPCommandFrameOutGoingErrorAttribute ........................................................... 815

ErInjSetSTPCommandFrameInComingErrorAttribute ............................................................ 816

ErInjGetSTPCommandFrameInComingErrorAttribute ........................................................... 817

ErInjSetATAPICommandCheckConditionErrorAttribute ........................................................ 818

ErInjGetATAPICommandCheckConditionErrorAttribute ........................................................ 819

ISerialSCSIExtraction ..................................................................................... 820

Methods .................................................................................................. 820

Open ...................................................................................................................................... 822

Close ...................................................................................................................................... 822

SetAssociateLayers ................................................................................................................ 823

ExpandAllPackets ................................................................................................................... 823

GetTotalPacketCount............................................................................................................. 824

GetPacketProperties .............................................................................................................. 825

GetLinkPacketType ................................................................................................................ 826

GetFieldStream ...................................................................................................................... 827

GetFieldData .......................................................................................................................... 828

GetFieldName ........................................................................................................................ 829

GetFieldId .............................................................................................................................. 829

GetFieldDescription ............................................................................................................... 830

ExpandPacket ........................................................................................................................ 831

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 23

ExpandField ........................................................................................................................... 832

Save ....................................................................................................................................... 832

SaveAsText ............................................................................................................................. 833

FindPacket ............................................................................................................................. 834

GetSearchObject .................................................................................................................... 835

DumpAndExtract ................................................................................................................... 835

SetAnalyzerLinkEnable ........................................................................................................... 836

SetAssociateChannels ............................................................................................................ 837

GetPacketData ....................................................................................................................... 838

AddAssignedElement ............................................................................................................. 838

RemoveAllAssigendElements ................................................................................................ 839

UpdateAssignedSCSICommand ............................................................................................. 839

SetSecondAnalyzerId ............................................................................................................. 840

SetWidePort .......................................................................................................................... 840

SetBoardType ........................................................................................................................ 841

GetBoardType ........................................................................................................................ 841

SetBoardTypeToSample ......................................................................................................... 842

OpenDefaultAliasingManager ............................................................................................... 842

GetExistHashAddress ............................................................................................................. 843

GetExistSCSICommandStatus ................................................................................................ 843

GetPErrorExist ....................................................................................................................... 844

GetNumberOfSamplePorts .................................................................................................... 844

Properties ................................................................................................ 845

ISearchInfo .................................................................................................... 846

Methods .................................................................................................. 846

Properties ................................................................................................ 849

Appendices .................................................................................................... 851

API Constants .............................................................................................................. 852

Address Frame type definition ..................................................................... 852

Addressing Type definition ........................................................................... 852

Affiliation Setting definition .......................................................................... 852

ATA Capacity Type definition ........................................................................ 852

ATA Command Timeout Recovery definition ............................................... 853

ATA Device Emul Error and Status Register definition ................................. 853

Block Descriptor Type definition ................................................................... 853

Bus Condition definition ............................................................................... 854

Capacity Unit Definition ................................................................................ 854

Capture ID definition ..................................................................................... 854

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 24

Capture Project Mode definition .................................................................. 854

Capture strategy definition ........................................................................... 855

CCEI Data Type definition ............................................................................. 855

Close Sequence Type definition .................................................................... 855

Command type definition ............................................................................. 856

Condition type definition .............................................................................. 860

Correction Type definition ............................................................................ 864

CRC Error Type definition.............................................................................. 864

Delay on Responding to Close definition ...................................................... 864

Device Types definition ................................................................................. 864

Dp Direct definition ....................................................................................... 864

EOF Error Type definition.............................................................................. 865

Error Injection Frame Protocol Type definition ............................................ 865

Exerciser Transport Frame Type definition................................................... 865

Expression Token Type definition ................................................................. 866

Expression Type definition ............................................................................ 866

FIS Type definition ........................................................................................ 866

Frame Length Error Type definition .............................................................. 867

Handshake Error Type definition .................................................................. 867

Handshake Type definition ........................................................................... 867

Inserted Frame Status definition .................................................................. 868

Instruction Memory Status definition .......................................................... 868

Instruction type definition ............................................................................ 868

SAS Layer definition ...................................................................................... 869

Link mode packet definition ......................................................................... 869

Loop type definition ...................................................................................... 870

Option ID definition ...................................................................................... 870

Pattern Types definition ............................................................................... 876

Pattern Using Type definition ....................................................................... 876

Port Type definition ...................................................................................... 877

Power Management Instruction Type definition ......................................... 877

Power Mng Instr definition ........................................................................... 877

PrimitivesEnum ............................................................................................. 878

Primitive type definition ............................................................................... 881

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 25

Product Type definition ................................................................................ 881

Project Type definition .................................................................................. 881

Protocol Type definition ............................................................................... 881

Radix definition ............................................................................................. 882

Resolution definition ..................................................................................... 882

SAS Speed Negotiation Failure Type definition ............................................ 882

SATA Speed Negotiation Failure Type definition .......................................... 882

SCSI Command type definition ..................................................................... 883

SCSI Spec definition ....................................................................................... 890

Search direction definition ........................................................................... 890

Sending Frame Type For Terminate Reception Frame definition ................ 891

Sense Data definition .................................................................................... 891

SMP Frame Function definition .................................................................... 892

SMP Frame type definition ........................................................................... 892

SMP Function Result definition .................................................................... 893

SOF Error Type definition .............................................................................. 893

Speed definition ............................................................................................ 893

Speed Negotiation Failure By definition ....................................................... 894

Speed Negotiation Failure definition ............................................................ 894

SSP Frame type definition ............................................................................. 894

SSP Task Management Response definition ................................................. 895

Target Element Type definition .................................................................... 895

Target Emul Device Type definition .............................................................. 895

Target Emulator ATA PE definition ............................................................... 896

Target Emulator ATA Protocol Command Type definition ........................... 896

Target Emulator ATAPI Command Type definition ....................................... 896

Target Emulator ATAPI Error Status Reg definition ...................................... 896

Target emulator CmnEr Interval Type definition .......................................... 897

Target Emulator Device Type definition ....................................................... 897

Target Emulator Error Injection Type On Command definition ................... 897

Target Emulator PE definition ....................................................................... 898

Target Emulator SCSI Command Error Type definition ................................ 898

Target Emulator SCSI Page definition ........................................................... 898

Target Emulator STP Command Error Type definition ................................. 899

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 26

Target Emulator Task Mangment Error Type definition ............................... 899

Target Emulator User-defined Command Protocol Type definition ............ 899

Target Emulator User-defined Command Type definition ........................... 899

Task Attribute definition ............................................................................... 900

Task Management Type definition ............................................................... 900

Time Unit definition ...................................................................................... 900

Trig strategy definition .................................................................................. 901

Trigger Source definition .............................................................................. 901

TX Frame Error on Field definition ................................................................ 901

Wake Up Instr Type definition ...................................................................... 901

Wake Up Instruction Type definition ............................................................ 901

Wide Port Type definition ............................................................................. 902

DeviceTypeConfigurationTypeEnum ............................................................ 902

Pattern Parameters ............................................................................................................ 904

Timer Pattern parameters ............................................................................ 904

External Trigs Pattern parameters ................................................................ 904

BUS Condition Pattern parameters .............................................................. 904

Symbol Pattern parameter ........................................................................... 904

Primitive Pattern parameter ......................................................................... 904

FIS Pattern parameters ................................................................................. 905

ATA Command Pattern parameters.............................................................. 908

ATA Command Pattern parameters.............................................................. 912

Address Frame Pattern parameters ............................................................. 912

SMP, STP and SMP Pattern parameters ....................................................... 914

Data Pattern parameters .............................................................................. 923

Protocol Errors Pattern parameters ............................................................. 924

Soft Reset Pattern parameters ..................................................................... 924

SCSI Command Pattern parameters ............................................................. 925

API Examples .............................................................................................................. 959

Test Capture Project ..................................................................................... 959

General .................................................................................................... 959

Specification ............................................................................................ 959

Limitation ................................................................................................ 960

Multi Run Project .......................................................................................... 960

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 27

General .................................................................................................... 960

Specification ............................................................................................ 960

Limitation ................................................................................................ 960

Sample Viewer .............................................................................................. 961

General .................................................................................................... 961

Specification ............................................................................................ 961

Limitation ................................................................................................ 961

ATAPI Sample ................................................................................................ 961

General .................................................................................................... 961

Specification ............................................................................................ 961

Limitation ................................................................................................ 962

Read Write Verify .......................................................................................... 962

General .................................................................................................... 962

Specification ............................................................................................ 962

Limitation ................................................................................................ 962

TestTrainer API .............................................................................................. 963

General .................................................................................................... 963

Specification ............................................................................................ 963

Limitation ................................................................................................ 963

China Restriction of Hazardous Substances Table ............................................................... 964

How to Contact LeCroy....................................................................................................... 965

Index .............................................................................................................. 966

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 28

Introduction

The SAS/SATA API has three types of API:

• STX API: For analyzer, emulators, and Trainer

• CATC API: For analyzer and Trainer

• Infusion API: Only for Infusion

SASEngine is a COM-based library that enables programmers to use some SAS software
functionality in their programs. This library manages all hardware functions. The library includes
some internal Interfaces to detect and set device options and to program SAS hardware.

The software is for use with applications developed under COM-supported platforms, such as
Microsoft® Visual C++™, Borland® Delphi™, and Microsoft Visual Basic™.

First, you must use a COM-supported platform.

Second, you must follow some instructions in programs.

To use API functions, you initialize your application and attach to a board. After initializing your
application and attaching to a board, create an instance of the COM Object. Then use the API
functions.

The most important sections of the SAS/SATA Protocol Suite, STX software are Analyzer and
Emulators.

API Description

The following is the Object Model:

GeneralSrv

This COM class can initialize, shut down the system, and attach to and detach from board.

SerialSCSICaptureProject

This COM Object can trigger, capture, and run a project.

ExerciserEngine

This COM Object can set up an initiator/host emulator and run it.

InitiatorErrorInjection

This COM Object can inject errors on commands or frames in host emulator.

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 29

TargetEmulatorEngine

This COM Object can set up a target/device emulator and activate it.

TargetErrorInjection

This COM Object can inject errors on commands or frames in device emulator.

Extraction

This COM Object can create and open sample files and get information about packets.

Search

This COM Object can search inside sample files.

APISrv

This object comes from merging Trainer API functionality and analyzer API functionality.

This object can create all other API objects. You can get other objects from this object and then
use them.

Sierra SAS/SATA Protocol Suite, STX Software API Reference Manual

API Description 30