1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: boss_Lib.h 4 5 Copyright (C)2009-2012 Nintendo Co., Ltd. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 $Rev: 50072 $ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_BOSS_BOSS_LIB_H_ 17 #define NN_BOSS_BOSS_LIB_H_ 18 19 #include <nn/os/os_Event.h> 20 #include <nn/fs/fs_Parameters.h> 21 22 #include <nn/boss/boss_Const.h> 23 #include <nn/boss/boss_Result.h> 24 #include <nn/boss/boss_Types.h> 25 26 #include <nn/boss/boss_TaskPolicy.h> 27 #include <nn/boss/boss_TaskStatus.h> 28 #include <nn/boss/boss_TaskOption.h> 29 #include <nn/boss/boss_TaskError.h> 30 #include <nn/boss/boss_TaskAction.h> 31 #include <nn/boss/boss_Task.h> 32 #include <nn/boss/boss_TaskIdList.h> 33 #include <nn/boss/boss_StepIdList.h> 34 #include <nn/boss/boss_NsDataIdList.h> 35 36 37 #ifdef __cplusplus 38 39 namespace nn { 40 namespace boss { 41 42 /* Please see man pages for details 43 44 45 46 47 48 49 */ 50 nn::Result Initialize(void); 51 52 /* Please see man pages for details 53 54 55 56 57 58 */ 59 nn::Result Finalize(void); 60 61 /* Please see man pages for details 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 */ 82 nn::Result RegisterPrivateRootCa(const u8* pCertData, size_t certDataSize); 83 84 /* Please see man pages for details 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 */ 107 nn::Result RegisterPrivateClientCert(const u8* pCertData, size_t certDataSize 108 , const u8* pPrivateKeyData, size_t privateKeyDataSize); 109 110 /* Please see man pages for details 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 nn::Result RegisterTask(Task* pTask, TaskPolicy* pPolicy , TaskAction* pAction 161 , TaskOption* pOption=NULL 162 , u8 taskStep=DEFAULT_STEP_ID); 163 164 /* Please see man pages for details 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 nn::Result RegisterTask(Task* pTask, TaskPolicy* pPolicy, TaskAction* pAction, const char* pFilePath 200 , TaskOption* pOption=NULL 201 , u8 taskStep=DEFAULT_STEP_ID); 202 203 /* Please see man pages for details 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 nn::Result RegisterImmediateTask(Task* pTask, TaskAction* pAction 247 , TaskPolicy* pPolicy=NULL 248 , TaskOption* pOption=NULL 249 , u8 taskStep=DEFAULT_STEP_ID); 250 251 /* Please see man pages for details 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 nn::Result RegisterImmediateTask(Task* pTask, TaskAction* pAction, const char* pFilePath 284 , TaskPolicy* pPolicy=NULL 285 , TaskOption* pOption=NULL 286 , u8 taskStep=DEFAULT_STEP_ID); 287 288 /* Please see man pages for details 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 nn::Result UnregisterTask(Task* pTask, u8 taskStep=DEFAULT_STEP_ID); 316 317 /* Please see man pages for details 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 */ 341 nn::Result ReconfigureTask(Task* pTask, TaskPolicy* pPolicy, u8 taskStep=DEFAULT_STEP_ID); 342 343 /* Please see man pages for details 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 */ 359 nn::Result GetTaskIdList(TaskIdList* pTaskIdList); 360 361 /* Please see man pages for details 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 */ 382 nn::Result GetStepIdList(const char* pTaskId, StepIdList* pStepIdList); 383 384 /* Please see man pages for details 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 nn::Result RegisterStorage(bit32 storageId, size_t storageSize, nn::boss::StorageType storageType=nn::boss::USER_EXT_SAVEDATA_STORAGE); 425 426 /* Please see man pages for details 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 nn::Result RegisterStorage(bit32 storageId, size_t storageSize, u16 entryCount, nn::boss::StorageType storageType=nn::boss::USER_EXT_SAVEDATA_STORAGE); 468 469 /* Please see man pages for details 470 471 472 473 474 475 476 477 478 479 480 481 */ 482 nn::Result UnregisterStorage(void); 483 484 485 /* Please see man pages for details 486 487 488 489 490 491 492 493 494 495 496 497 */ 498 nn::Result GetStorageInfo(size_t* pStorageSize=NULL); 499 500 /* Please see man pages for details 501 502 503 504 505 506 507 508 509 510 511 512 513 */ 514 nn::Result GetStorageInfo(size_t* pStorageSize, u16* pEntryCount); 515 516 /* Please see man pages for details 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 */ 534 nn::Result GetNewArrivalFlag(bool* pFlag); 535 536 /* Please see man pages for details 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 */ 552 nn::Result RegisterNewArrivalEvent(nn::os::Event* event); 553 554 /* Please see man pages for details 555 556 557 */ 558 nn::Result GetNewArrivalEvent(nn::os::Event* event) NN_ATTRIBUTE_DEPRECATED; 559 560 /* Please see man pages for details 561 562 563 564 565 566 567 568 569 570 571 572 573 */ 574 nn::Result SetOptoutFlag(bool flag); 575 576 /* Please see man pages for details 577 578 579 580 581 582 583 584 585 586 587 588 */ 589 nn::Result GetOptoutFlag(bool* pFlag); 590 591 /* Please see man pages for details 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 nn::Result GetNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 638 639 /* Please see man pages for details 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 nn::Result GetOwnNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 672 673 /* Please see man pages for details 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 nn::Result GetNewDataNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 704 705 /* Please see man pages for details 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 */ 738 nn::Result GetOwnNewDataNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 739 740 741 /* Please see man pages for details 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 */ 761 nn::Result GetErrorCode( u32* pOut, TaskResultCode targetResult ); 762 763 } // end of namespace boss 764 } // end of namespace nn 765 766 #endif // __cplusplus 767 768 #endif /* NN_BOSS_BOSS_LIB_H_ */ 769