1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
|
/*******************************************************************************
*Copyright (c) 2014 PMC-Sierra, Inc. All rights reserved.
*
*Redistribution and use in source and binary forms, with or without modification, are permitted provided
*that the following conditions are met:
*1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
*following disclaimer.
*2. Redistributions in binary form must reproduce the above copyright notice,
*this list of conditions and the following disclaimer in the documentation and/or other materials provided
*with the distribution.
*
*THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED
*WARRANTIES,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
*FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
*NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
*BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
*LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
*SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
*
* $FreeBSD$
*
********************************************************************************/
/*******************************************************************************/
/*! \file saapi.h
* \brief The file defines the declaration of tSDK APIs
*
*
*
*
*/
/******************************************************************************/
#ifndef __SSDKAPI_H__
#define __SSDKAPI_H__
/********************************************************************************
* SA LL Function Declaration *
********************************************************************************/
/***************************************************************************
* Definition of interrupt related functions start *
***************************************************************************/
GLOBAL bit32 FORCEINLINE saDelayedInterruptHandler(
agsaRoot_t *agRoot,
bit32 interruptVectorIndex,
bit32 count
);
GLOBAL bit32 FORCEINLINE saInterruptHandler(
agsaRoot_t *agRoot,
bit32 interruptVectorIndex
);
GLOBAL void saSystemInterruptsActive(
agsaRoot_t *agRoot,
agBOOLEAN sysIntsActive
);
GLOBAL FORCEINLINE void saSystemInterruptsEnable(
agsaRoot_t *agRoot,
bit32 interruptVectorIndex
);
/***************************************************************************
* Definition of interrupt related functions end *
***************************************************************************/
/***************************************************************************
* Definition of timer related functions start *
***************************************************************************/
GLOBAL void saTimerTick(agsaRoot_t *agRoot);
/***************************************************************************
* Definition of timer related functions end *
***************************************************************************/
/***************************************************************************
* Definition of initialization related functions start *
***************************************************************************/
GLOBAL void saGetRequirements(
agsaRoot_t *agRoot,
agsaSwConfig_t *swConfig,
agsaMemoryRequirement_t *memoryRequirement,
bit32 *usecsPerTick,
bit32 *maxNumLocks
);
GLOBAL bit32 saInitialize(
agsaRoot_t *agRoot,
agsaMemoryRequirement_t *memoryAllocated,
agsaHwConfig_t *hwConfig,
agsaSwConfig_t *swConfig,
bit32 usecsPerTick
);
/***************************************************************************
* Definition of initialization related functions end *
***************************************************************************/
/***************************************************************************
* Definition of hardware related functions start *
***************************************************************************/
GLOBAL void saHwReset(
agsaRoot_t *agRoot,
bit32 resetType,
bit32 resetParm
);
GLOBAL void saHwShutdown(agsaRoot_t *agRoot);
/***************************************************************************
* Definition of hardware related functions end *
***************************************************************************/
/***************************************************************************
* Definition of phy related functions start *
***************************************************************************/
GLOBAL bit32 saPhyStart(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 phyId,
agsaPhyConfig_t *agPhyConfig,
agsaSASIdentify_t *agSASIdentify
);
GLOBAL bit32 saPhyStop(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 phyId
);
GLOBAL bit32 saLocalPhyControl(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 phyId,
bit32 phyOperation,
ossaLocalPhyControlCB_t agCB
);
GLOBAL bit32 saGetPhyProfile(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 ppc,
bit32 phyID
);
GLOBAL bit32 saSetPhyProfile (
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 ppc,
bit32 length,
void *buffer,
bit32 phyID
);
GLOBAL bit32 saHwEventAck(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaEventSource_t *eventSource,
bit32 param0,
bit32 param1
);
/***************************************************************************
* Definition of phy related functions end *
***************************************************************************/
/***************************************************************************
* Definition of discovery related functions start *
***************************************************************************/
GLOBAL bit32 saDiscover(
agsaRoot_t *agRoot,
agsaPortContext_t *agPortContext,
bit32 type,
bit32 option
);
/***************************************************************************
* Definition of discovery related functions end *
***************************************************************************/
/***************************************************************************
* Definition of frame related functions start *
***************************************************************************/
GLOBAL bit32 saFrameReadBit32(
agsaRoot_t *agRoot,
agsaFrameHandle_t agFrame,
bit32 frameOffset
);
GLOBAL void saFrameReadBlock(
agsaRoot_t *agRoot,
agsaFrameHandle_t agFrame,
bit32 frameOffset,
void *frameBuffer,
bit32 frameBufLen
);
/***************************************************************************
* Definition of frame related functions end *
***************************************************************************/
/***************************************************************************
* Definition of SATA related functions start *
***************************************************************************/
GLOBAL bit32 saSATAStart(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 agRequestType,
agsaSATAInitiatorRequest_t *agSATAReq,
bit8 agTag,
ossaSATACompletedCB_t agCB
);
GLOBAL bit32 saSATAAbort(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 flag,
void *abortParam,
ossaGenericAbortCB_t agCB
);
/***************************************************************************
* Definition of SATA related functions end *
***************************************************************************/
/***************************************************************************
* Definition of SAS related functions start *
***************************************************************************/
GLOBAL bit32 saSendSMPIoctl(
agsaRoot_t *agRoot,
agsaDevHandle_t *agDevHandle,
bit32 queueNum,
agsaSMPFrame_t *pSMPFrame,
ossaSMPCompletedCB_t agCB
);
GLOBAL bit32 saSMPStart(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 agRequestType,
agsaSASRequestBody_t *agRequestBody,
ossaSMPCompletedCB_t agCB
);
GLOBAL bit32 saSMPAbort(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 flag,
void *abortParam,
ossaGenericAbortCB_t agCB
);
GLOBAL bit32 saSSPStart(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 agRequestType,
agsaSASRequestBody_t *agRequestBody,
agsaIORequest_t *agTMRequest,
ossaSSPCompletedCB_t agCB
);
#ifdef FAST_IO_TEST
GLOBAL void *saFastSSPPrepare(
void *ioHandle,
agsaFastCommand_t *fc,
ossaSSPCompletedCB_t cb,
void *cbArg);
GLOBAL bit32 saFastSSPSend(void *ioHandle);
GLOBAL bit32 saFastSSPCancel(void *ioHandle);
#endif
GLOBAL bit32 saSSPAbort(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 flag,
void *abortParam,
ossaGenericAbortCB_t agCB
);
GLOBAL void saGetDifErrorDetails(
agsaRoot_t *agRoot,
agsaIORequest_t *agIORequest,
agsaDifDetails_t *difDetails
);
GLOBAL bit32 saRegisterEventCallback(
agsaRoot_t *agRoot,
bit32 eventSourceType,
ossaGenericCB_t callbackPtr
);
/***************************************************************************
* Definition of SAS related functions end *
***************************************************************************/
/***************************************************************************
* Definition of Device related functions start *
***************************************************************************/
GLOBAL bit32 saRegisterNewDevice(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaDeviceInfo_t *agDeviceInfo,
agsaPortContext_t *agPortContext,
bit16 hostAssignedDeviceId
);
GLOBAL bit32 saDeregisterDeviceHandle(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
agsaDevHandle_t *agDevHandle,
bit32 queueNum
);
GLOBAL bit32 saGetDeviceHandles(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaPortContext_t *agPortContext,
bit32 flags,
agsaDevHandle_t *agDev[],
bit32 skipCount,
bit32 maxDevs
);
GLOBAL bit32 saGetDeviceInfo(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 option,
bit32 queueNum,
agsaDevHandle_t *agDevHandle
);
GLOBAL bit32 saGetDeviceState(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaDevHandle_t *agDevHandle
);
GLOBAL bit32 saSetDeviceInfo(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum ,
agsaDevHandle_t *agDevHandle,
bit32 option,
bit32 param,
ossaSetDeviceInfoCB_t agCB
);
GLOBAL bit32 saSetDeviceState(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaDevHandle_t *agDevHandle,
bit32 newDeviceState
);
/***************************************************************************
* Definition of Device related functions end *
***************************************************************************/
/***************************************************************************
* Definition of Misc related functions start *
***************************************************************************/
GLOBAL bit32 saFwFlashUpdate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaUpdateFwFlash_t *flashUpdateInfo
);
GLOBAL bit32 saFlashExtExecute (
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaFlashExtExecute_t *agFlashExtExe
);
#ifdef SPC_ENABLE_PROFILE
GLOBAL bit32 saFwProfile(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaFwProfile_t *fwProfileInfo
);
#endif
GLOBAL bit32 saEchoCommand(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
void *echoPayload
);
GLOBAL bit32 saGetControllerInfo(
agsaRoot_t *agRoot,
agsaControllerInfo_t *controllerInfo
);
GLOBAL bit32 saGetControllerStatus(
agsaRoot_t *agRoot,
agsaControllerStatus_t *controllerStatus
);
GLOBAL bit32 saGetControllerEventLogInfo(
agsaRoot_t *agRoot,
agsaControllerEventLog_t *eventLogInfo
);
GLOBAL bit32 saGpioEventSetup(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaGpioEventSetupInfo_t *gpioEventSetupInfo
);
GLOBAL bit32 saGpioPinSetup(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaGpioPinSetupInfo_t *gpioPinSetupInfo
);
GLOBAL bit32 saGpioRead(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum
);
GLOBAL bit32 saGpioWrite(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 gpioWriteMask,
bit32 gpioWriteValue
);
GLOBAL bit32 saSASDiagExecute(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaSASDiagExecute_t *diag
);
GLOBAL bit32 saSASDiagStartEnd(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 phyId,
bit32 operation
);
GLOBAL bit32 saGetTimeStamp(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum
);
GLOBAL bit32 saPortControl(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaPortContext_t *agPortContext,
bit32 portOperation,
bit32 param0,
bit32 param1
);
GLOBAL bit32 saGetRegisterDump(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaRegDumpInfo_t *regDumpInfo
);
GLOBAL bit32 saGetForensicData(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
agsaForensicData_t *forensicData
);
bit32 saGetIOErrorStats(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 flag
);
bit32 saGetIOEventStats(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 flag
);
GLOBAL bit32 saGetNVMDCommand(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaNVMDData_t *NVMDInfo
);
GLOBAL bit32 saSetNVMDCommand(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaNVMDData_t *NVMDInfo
);
GLOBAL bit32 saReconfigSASParams(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum ,
agsaSASReconfig_t *agSASConfig
);
GLOBAL bit32 saSgpio(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaSGpioReqResponse_t *pSGpioReq
);
GLOBAL bit32 saPCIeDiagExecute(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaPCIeDiagExecute_t *diag);
GLOBAL bit32 saEncryptSelftestExecute(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 type,
bit32 length,
void *TestDescriptor);
GLOBAL bit32 saSetOperator(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 flag,
void *cert);
GLOBAL bit32 saGetOperator(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 option,
bit32 AddrHi,
bit32 AddrLo);
GLOBAL bit32 saOperatorManagement(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 flag,
bit8 role,
agsaID_t *id,
agsaEncryptKekBlob_t *kblob);
/***************************************************************************
* Definition of Misc. related functions end *
***************************************************************************/
GLOBAL bit32 saSetControllerConfig(
agsaRoot_t *agRoot,
bit32 queueNum,
bit32 modePage,
bit32 length,
void *buffer,
agsaContext_t *agContext
);
GLOBAL bit32 saGetControllerConfig(
agsaRoot_t *agRoot,
bit32 queueNum,
bit32 modePage,
bit32 flag0,
bit32 flag1,
agsaContext_t *agContext
);
GLOBAL bit32 saEncryptDekCacheUpdate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 kekIndex,
bit32 dekTableSelect,
bit32 dekAddrHi,
bit32 dekAddrLo,
bit32 dekIndex,
bit32 dekNumberOfEntries,
bit32 dekBlobFormat,
bit32 dekTableKeyEntrySize
);
GLOBAL bit32 saEncryptDekCacheInvalidate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 dekTable,
bit32 dekIndex
);
GLOBAL bit32 saEncryptGetMode(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
agsaEncryptInfo_t *encryptInfo
);
GLOBAL bit32 saEncryptSetMode (
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
agsaEncryptInfo_t *mode
);
GLOBAL bit32 saEncryptKekInvalidate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 kekIndex
);
GLOBAL bit32 saEncryptKekUpdate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 flags,
bit32 newKekIndex,
bit32 wrapperKekIndex,
bit32 blobFormat,
agsaEncryptKekBlob_t *encryptKekBlob
);
#ifdef HIALEAH_ENCRYPTION
GLOBAL bit32 saEncryptHilUpdate(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum
);
#endif /* HIALEAH_ENCRYPTION */
GLOBAL bit32 saGetDFEData(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 interface,
bit32 laneNumber,
bit32 interations,
agsaSgl_t *agSgl);
GLOBAL bit32 saFatalInterruptHandler(
agsaRoot_t *agRoot,
bit32 interruptVectorIndex
);
GLOBAL bit32 saDIFEncryptionOffloadStart(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 op,
agsaDifEncPayload_t *agsaDifEncPayload,
ossaDIFEncryptionOffloadStartCB_t agCB);
GLOBAL bit32 saVhistCapture(
agsaRoot_t *agRoot,
agsaContext_t *agContext,
bit32 queueNum,
bit32 Channel,
bit32 NumBitLo,
bit32 NumBitHi,
bit32 PcieAddrLo,
bit32 PcieAddrHi,
bit32 ByteCount );
GLOBAL void saCountActiveIORequests( agsaRoot_t *agRoot);
#ifdef SA_64BIT_TIMESTAMP
osGLOBAL bit64 osTimeStamp64(void);
#endif /* SA_64BIT_TIMESTAMP */
#ifdef SALL_API_TEST
/***************************************************************************
* Definition of LL Test related API functions start *
***************************************************************************/
GLOBAL bit32 saGetLLCounters(
agsaRoot_t *agRoot,
bit32 counters,
agsaLLCountInfo_t *LLCountInfo
);
GLOBAL bit32 saResetLLCounters(
agsaRoot_t *agRoot,
bit32 counters
);
#endif
#endif /*__SSDKAPI_H__ */
|
