1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: fs_FileSystemBase.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: 48204 $ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_FS_CTR_MPCORE_FS_FILESYSTEMBASE_H_ 17 #define NN_FS_CTR_MPCORE_FS_FILESYSTEMBASE_H_ 18 19 #include <nn/Handle.h> 20 #include <nn/fs/CTR/MPCore/fs_UserFileSystem.h> 21 22 namespace nn { namespace fs { namespace detail { 23 24 class FileSystemBaseImpl : public nn::fs::CTR::MPCore::detail::UserFileSystem 25 { 26 }; 27 28 }}} 29 30 namespace nn { namespace fs { 31 32 //---------------------------------------- 33 // 34 // 35 36 /* Please see man pages for details 37 38 39 40 41 42 43 44 45 46 47 48 49 */ 50 s32 GetRomRequiredMemorySize(size_t maxFile, size_t maxDirectory, bool useCache = true); 51 52 /* Please see man pages for details 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 Result MountRom(const char* archiveName, size_t maxFile, size_t maxDirectory, void* workingMemory, size_t workingMemorySize, bool useCache = true); 81 Result MountRom(size_t maxFile, size_t maxDirectory, void* workingMemory, size_t workingMemorySize, bool useCache = true); 82 83 // 84 85 //---------------------------------------- 86 // 87 // 88 89 /* Please see man pages for details 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 */ 111 Result FormatSaveData(size_t maxFiles, size_t maxDirectories, bool isDuplicateAll = false); 112 113 /* Please see man pages for details 114 115 116 117 118 119 120 121 122 123 124 125 126 */ 127 Result GetSaveDataFormatInfo(size_t* maxFiles, size_t* maxDirectories, bool* isDuplicateAll); 128 129 /* Please see man pages for details 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 Result MountSaveData(const char* archiveName = "data:"); 155 156 Result MountSaveData(const char* archiveName, bit32 uniqueId, bit8 variation); 157 158 /* Please see man pages for details 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 Result MountSaveData(const char* archiveName, bit32 uniqueId); 191 192 /* Please see man pages for details 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 Result MountDemoSaveData(const char* archiveName, bit32 uniqueId, bit8 demoIndex); 224 225 /* Please see man pages for details 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 */ 244 Result CommitSaveData(const char* archiveName = "data:"); 245 246 // 247 248 //---------------------------------------- 249 // 250 // 251 252 /* Please see man pages for details 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 Result CreateExtSaveData(nn::fs::ExtSaveDataId id, const void* iconData, size_t iconDataSize, u32 entryDirectory, u32 entryFile); 283 284 /* Please see man pages for details 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 */ 305 Result GetExtSaveDataFormatInfo(u32* entryDirectory, u32* entryFile, nn::fs::ExtSaveDataId id); 306 307 /* Please see man pages for details 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 Result MountExtSaveData(const char* archiveName, nn::fs::ExtSaveDataId id); 340 341 /* Please see man pages for details 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 */ 359 Result DeleteExtSaveData(ExtSaveDataId id); 360 361 362 // 363 364 /* Please see man pages for details 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 */ 382 Result Unmount(const char* archiveName); 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 Result CreateArchiveAlias(const char* aliasArchiveName, const char* srcArchiveName); 409 410 //---------------------------------------- 411 // 412 // 413 414 /* Please see man pages for details 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 */ 435 Result MountSdmc(const char* archiveName = "sdmc:"); 436 437 /* Please see man pages for details 438 439 440 */ 441 void InitializeLatencyEmulation( void); 442 443 /* Please see man pages for details 444 445 446 */ 447 void ForceEnableLatencyEmulation( bool isEmulateEndurance = true, s64 constantWait = 0); 448 449 /* Please see man pages for details 450 451 452 */ 453 void ForceDisableLatencyEmulation( void ); 454 455 // 456 457 //---------------------------------------- 458 // 459 // 460 461 /* Please see man pages for details 462 463 464 465 466 467 468 469 470 471 472 473 474 475 */ 476 Result SetArchivePriority(const char* archiveName, s32 priority); 477 478 /* Please see man pages for details 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 */ 495 Result GetArchivePriority(s32* pOut, const char* archiveName); 496 // 497 498 //---------------------------------------- 499 // 500 // 501 502 /* Please see man pages for details 503 504 505 506 507 508 509 510 511 512 513 514 515 516 */ 517 void SetSaveDataSecureValue(bit64 value); 518 519 /* Please see man pages for details 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 */ 536 void SetSaveDataSecureValue(bit64 value, bit64 mask); 537 538 /* Please see man pages for details 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 bool VerifySaveDataSecureValue(bit64 value); 566 567 /* Please see man pages for details 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 bool VerifySaveDataSecureValue(bit64 value, bit64 mask); 597 598 /* Please see man pages for details 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 */ 622 bool VerifySaveDataSecureValueLoosely(bit64 value); 623 624 /* Please see man pages for details 625 626 627 628 629 630 631 632 633 634 635 636 637 */ 638 void SetOtherSaveDataSecureValue(bit64 value, bit32 uniqueId, bit8 variation); 639 640 /* Please see man pages for details 641 642 643 644 645 646 647 648 649 650 651 652 653 654 */ 655 bit64 GetOtherSaveDataSecureValue(bit32 uniqueId, bit8 variation); 656 657 // 658 659 660 // TODO: Other details 661 662 /* Please see man pages for details 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 */ 680 Result GetArchiveFreeBytes(s64* pOut, const char* archiveName); 681 682 /* Please see man pages for details 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 */ 702 void SetAnalysisLog(bool enabled); 703 704 705 }} 706 707 708 #ifdef NN_SWITCH_ENABLE_HOST_IO 709 namespace nn { namespace fs { 710 711 /* Please see man pages for details 712 713 714 715 716 717 */ 718 namespace hio { 719 720 /* Please see man pages for details 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 */ 738 Result MountHioArchive(const char* archiveName, const wchar_t* hostPath, size_t maxFile, size_t maxDirectory, void* workingMemory, size_t workingMemorySize); 739 740 /* Please see man pages for details 741 742 743 744 745 746 747 748 749 750 */ 751 s32 GetHioRequiredMemorySize(size_t maxFile, size_t maxDirectory); 752 753 }}} 754 #endif//NN_SWITCH_ENABLE_HOST_IO 755 756 #endif 757