1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: ir_Communicator.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:$ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_IR_CTR_IR_COMMUNICATOR_H_ 17 #define NN_IR_CTR_IR_COMMUNICATOR_H_ 18 19 #include <nn/types.h> 20 #include <nn/fnd.h> 21 #include <nn/Result.h> 22 #include <nn/ir/CTR/ir_Types.h> 23 24 namespace nn { 25 namespace ir { 26 namespace CTR{ 27 28 /* 29 30 */ 31 class Communicator 32 { 33 private: Communicator()34 Communicator() {}; ~Communicator()35 ~Communicator() {}; 36 37 38 public: 39 /* Please see man pages for details 40 41 42 */ 43 static const size_t IR_PASSPHRASE_LENGTH_MIN = 8; // 44 static const size_t IR_PASSPHRASE_LENGTH_MAX = 255; // 45 /* 46 47 */ 48 49 50 /* Please see man pages for details 51 52 53 54 */ 55 56 /* Please see man pages for details 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 static Result Initialize( 84 void* pBuf, size_t bufSize, 85 size_t receiveBufferDataSize, size_t receiveBufferManagementSize, 86 size_t sendBufferDataSize, size_t sendBufferManagementSize, 87 nn::ir::CTR::BaudRate baudrate = nn::ir::CTR::BAUD_RATE_115200); 88 89 /* Please see man pages for details 90 91 92 93 94 95 96 97 */ 98 static Result Finalize(void); 99 100 /* 101 102 */ 103 104 /* Please see man pages for details 105 106 107 108 */ 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 static Result WaitConnection(); 144 145 /* Please see man pages for details 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 */ 165 static Result WaitConnection(nn::fnd::TimeSpan sendReplyDelay); 166 167 /* Please see man pages for details 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 static Result RequireConnection(); 199 200 /* Please see man pages for details 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 static Result AutoConnection(); 244 245 /* Please see man pages for details 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 static Result AutoConnection(nn::fnd::TimeSpan sendReplyDelay, 281 nn::fnd::TimeSpan waitRequestMin, nn::fnd::TimeSpan waitRequestMax, 282 nn::fnd::TimeSpan waitReplyMin, nn::fnd::TimeSpan waitReplyMax); 283 284 /* Please see man pages for details 285 286 287 288 289 290 291 292 293 294 295 296 297 298 */ 299 static ConnectionRole GetConnectionRole(void); 300 301 /* Please see man pages for details 302 303 304 */ 305 306 /* Please see man pages for details 307 308 309 310 311 312 313 314 315 316 317 318 */ 319 static bit32 CreateCommunicationId( bit32 uniqueId, bool isDemo = false); 320 321 322 /* Please see man pages for details 323 324 325 326 327 328 */ 329 static bool IsConfirmedId(); 330 331 332 /* Please see man pages for details 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 static Result RequireToConfirmId(u8 subId, bit32 communicationId, const char passphrase[], size_t passphraseLength); 361 362 363 /* Please see man pages for details 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 static Result WaitToConfirmId(u8 subId, bit32 communicationId, const char passphrase[], size_t passphraseLength, nn::fnd::TimeSpan timeout); 393 394 395 /* 396 397 */ 398 399 400 /* Please see man pages for details 401 402 403 404 */ 405 406 /* Please see man pages for details 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 */ 430 static Result Disconnect(void); 431 432 /* 433 434 */ 435 436 /* Please see man pages for details 437 438 439 440 */ 441 442 /* Please see man pages for details 443 444 445 446 447 448 449 450 */ 451 static void GetReceiveEvent( nn::os::Event* pEvent); 452 453 /* Please see man pages for details 454 455 456 457 458 459 460 461 */ 462 static void GetSendEvent( nn::os::Event* pEvent); 463 464 /* Please see man pages for details 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 */ 484 static void GetConnectionStatusEvent( nn::os::Event* pEvent); 485 486 /* 487 488 */ 489 490 /* Please see man pages for details 491 492 493 494 */ 495 496 /* Please see man pages for details 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 static Result Receive(void* pDst, size_t size, size_t *pReceiveSize, s32 *pRemainCount); 536 537 /* Please see man pages for details 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 static Result Send(void *pBuffer, size_t dataSize, size_t bufferSize,bool restore = false); 572 573 /* 574 575 */ 576 577 /* Please see man pages for details 578 579 580 581 */ 582 583 /* Please see man pages for details 584 585 586 587 588 589 590 591 592 593 594 595 */ 596 static Result GetLatestReceiveErrorResult(bool clear); 597 598 /* Please see man pages for details 599 600 601 602 603 604 605 606 */ 607 static Result GetLatestSendErrorResult(bool clear); 608 609 /* Please see man pages for details 610 611 612 613 */ 614 static ConnectionStatus GetConnectionStatus(void); 615 616 /* Please see man pages for details 617 618 619 620 */ 621 static TryingToConnectStatus GetTryingToConnectStatus(void); 622 623 /* Please see man pages for details 624 625 626 627 628 629 630 631 632 633 */ 634 static void GetReceiveSizeFreeAndUsed(size_t *pSizeFree, s32 *pCountFree, size_t *pSizeUsed, s32 *pCountUsed); 635 636 /* Please see man pages for details 637 638 639 640 641 642 643 644 645 646 */ 647 static void GetSendSizeFreeAndUsed(size_t *pSizeFree, s32 *pCountFree, size_t *pSizeUsed, s32 *pCountUsed); 648 649 /* Please see man pages for details 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 */ 667 static Result GetNextReceiveDataSize(size_t *pSize); 668 669 /* 670 671 */ 672 673 /* Please see man pages for details 674 675 676 677 */ 678 679 /* Please see man pages for details 680 681 682 683 684 685 686 687 */ 688 static Result ClearReceiveBuffer(void); 689 690 /* Please see man pages for details 691 692 693 694 695 696 697 698 */ 699 static Result ClearSendBuffer(void); 700 701 /* Please see man pages for details 702 703 704 705 706 707 708 709 710 711 712 713 */ 714 static Result DropNextReceiveData(s32 *pRemainCount); 715 716 /* 717 718 */ 719 720 /* Please see man pages for details 721 722 723 724 */ 725 726 /* Please see man pages for details 727 728 729 730 731 732 733 734 */ 735 static size_t GetManagementSize(s32 dataNum); 736 737 /* Please see man pages for details 738 739 740 741 742 743 744 */ 745 static size_t GetPacketSize(size_t dataSize); 746 747 /* Please see man pages for details 748 749 750 751 */ 752 static size_t GetReservedSize(void); 753 754 /* Please see man pages for details 755 756 757 758 759 760 761 762 763 */ 764 static size_t CalculateBufferSizeToCommunicate(size_t dataSize); 765 766 767 /* Please see man pages for details 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 */ 785 static void GetAutoConnectionParametorFromBaudRate(nn::ir::CTR::BaudRate baudrate, 786 nn::fnd::TimeSpan* pWaitRequestMin, nn::fnd::TimeSpan* pWaitRequestMax, 787 nn::fnd::TimeSpan* pWaitReplyMin, nn::fnd::TimeSpan* pWaitReplyMax); 788 789 /* Please see man pages for details 790 791 792 793 794 795 796 797 798 */ 799 static nn::fnd::TimeSpan GetDefaultSendReplyDelay(void); 800 801 802 803 /* 804 805 */ 806 807 static nn::fnd::TimeSpan CalculateCommunicationTime(nn::ir::CTR::BaudRate baudrate,size_t size); 808 809 810 811 812 private : 813 static bool mIsConfirmed; 814 static nn::ir::CTR::BaudRate mBaudRate; 815 816 static void Reset(); 817 }; 818 819 } 820 } 821 } 822 823 824 #endif /* NN_IR_CTRCOMMUNICATIONAPI_H_ */ 825