1 /*---------------------------------------------------------------------------* 2 3 Copyright (C) Nintendo. All rights reserved. 4 5 These coded instructions, statements, and computer programs contain 6 proprietary information of Nintendo of America Inc. and/or Nintendo 7 Company Ltd., and are protected by Federal copyright law. They may 8 not be disclosed to third parties or copied or duplicated in any form, 9 in whole or in part, without the prior written consent of Nintendo. 10 11 *---------------------------------------------------------------------------*/ 12 13 // 14 // Do not edit this file. 15 // This file is automatically generated. 16 // 17 18 #ifndef NN_NFP_NFP_RESULT_H_ 19 #define NN_NFP_NFP_RESULT_H_ 20 21 #include <nn/Result.h> 22 #include <nn/Modules.h> 23 24 25 #ifdef __cplusplus 26 27 namespace nn { 28 namespace nfp { 29 30 //! @addtogroup nn_nfp_result 31 //! @{ 32 33 34 /*! 35 @class nn::nfp::ResultInvalidUsage 36 @brief An API function is not being used correctly. 37 38 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 39 40 @li @ref nn::nfp::ResultBufferIsSmall 41 @li @ref nn::nfp::ResultInvalidArgument 42 @li @ref nn::nfp::ResultInvalidPointer 43 @li @ref nn::nfp::ResultInvalidAlignment 44 45 46 */ 47 NN_DEFINE_RESULT_CONST_RANGE( 48 ResultInvalidUsage, 49 nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_NFP, 12800, 12800, 25600 50 ); 51 52 /*! 53 @class nn::nfp::ResultBufferIsSmall 54 @brief The specified buffer is too small. 55 56 This result is subsumed by the following results and can be caught by handling any of them. 57 58 @li @ref nn::nfp::ResultInvalidUsage 59 60 61 */ 62 NN_DEFINE_RESULT_CONST_RANGE( 63 ResultBufferIsSmall, 64 nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_NFP, 12928, 12928, 14080 65 ); 66 67 /*! 68 @class nn::nfp::ResultInvalidArgument 69 @brief Invalid argument. Revise the specified arguments. 70 71 This result is subsumed by the following results and can be caught by handling any of them. 72 73 @li @ref nn::nfp::ResultInvalidUsage 74 75 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 76 77 @li @ref nn::nfp::ResultInvalidPointer 78 @li @ref nn::nfp::ResultInvalidAlignment 79 80 81 82 */ 83 NN_DEFINE_RESULT_CONST_RANGE( 84 ResultInvalidArgument, 85 nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_NFP, 14080, 14080, 15360 86 ); 87 88 /*! 89 @class nn::nfp::ResultInvalidPointer 90 @brief An invalid pointer was specified. 91 92 This result is subsumed by the following results and can be caught by handling any of them. 93 94 @li @ref nn::nfp::ResultInvalidUsage 95 @li @ref nn::nfp::ResultInvalidArgument 96 97 98 */ 99 NN_DEFINE_RESULT_CONST_RANGE( 100 ResultInvalidPointer, 101 nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_NFP, 14208, 14208, 14336 102 ); 103 104 /*! 105 @class nn::nfp::ResultInvalidAlignment 106 @brief Invalid alignment. 107 108 This result is subsumed by the following results and can be caught by handling any of them. 109 110 @li @ref nn::nfp::ResultInvalidUsage 111 @li @ref nn::nfp::ResultInvalidArgument 112 113 114 */ 115 NN_DEFINE_RESULT_CONST_RANGE( 116 ResultInvalidAlignment, 117 nn::Result::LEVEL_USAGE, nn::RESULT_MODULE_NN_NFP, 14336, 14336, 14464 118 ); 119 120 /*! 121 @class nn::nfp::ResultInvalidOperation 122 @brief An invalid request was issued. Check the API function call order. If this error occurs even when called with the correct procedure, the Wii U console and the Wii U GamePad (DRC) might have different states. Try again from the beginning of the read/write sequence. 123 124 */ 125 NN_DEFINE_RESULT_CONST_RANGE( 126 ResultInvalidOperation, 127 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 25600, 25600, 26880 128 ); 129 130 /*! 131 @class nn::nfp::ResultNeedRetry 132 @brief If this error is returned, call the same API function again. The communication with the tag may be unstable. 133 134 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 135 136 @li @ref nn::nfp::ResultIsBusy 137 @li @ref nn::nfp::ResultTimeOutError 138 @li @ref nn::nfp::ResultConnectionError 139 140 141 */ 142 NN_DEFINE_RESULT_CONST_RANGE( 143 ResultNeedRetry, 144 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 38400, 38400, 51200 145 ); 146 147 /*! 148 @class nn::nfp::ResultIsBusy 149 @brief Indicates that the system is busy and cannot currently receive commands. 150 151 This result is subsumed by the following results and can be caught by handling any of them. 152 153 @li @ref nn::nfp::ResultNeedRetry 154 155 156 */ 157 NN_DEFINE_RESULT_CONST_RANGE( 158 ResultIsBusy, 159 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 38528, 38528, 39040 160 ); 161 162 /*! 163 @class nn::nfp::ResultTimeOutError 164 @brief Indicates a timeout error. There was no response from the Wii U GamePad (DRC) or the tag. 165 166 This result is subsumed by the following results and can be caught by handling any of them. 167 168 @li @ref nn::nfp::ResultNeedRetry 169 170 171 */ 172 NN_DEFINE_RESULT_CONST_RANGE( 173 ResultTimeOutError, 174 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 39040, 39040, 39552 175 ); 176 177 /*! 178 @class nn::nfp::ResultConnectionError 179 @brief Indicates a connection error. Something might be preventing normal communication with the tag. 180 181 This result is subsumed by the following results and can be caught by handling any of them. 182 183 @li @ref nn::nfp::ResultNeedRetry 184 185 186 */ 187 NN_DEFINE_RESULT_CONST_RANGE( 188 ResultConnectionError, 189 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 39552, 39552, 40064 190 ); 191 192 /*! 193 @class nn::nfp::ResultNotSupported 194 @brief The tag is not supported. Check that the tag is correct. 195 196 */ 197 NN_DEFINE_RESULT_CONST_RANGE( 198 ResultNotSupported, 199 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 51200, 51200, 57600 200 ); 201 202 /*! 203 @class nn::nfp::ResultNotFound 204 @brief The process target was not found. 205 206 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 207 208 @li @ref nn::nfp::ResultTagNotFound 209 @li @ref nn::nfp::ResultCharacterNotFound 210 211 212 */ 213 NN_DEFINE_RESULT_CONST_RANGE( 214 ResultNotFound, 215 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 57600, 57600, 64000 216 ); 217 218 /*! 219 @class nn::nfp::ResultTagNotFound 220 @brief Tag not found. The tag may have been removed from the reader or replaced during the process. 221 222 This result is subsumed by the following results and can be caught by handling any of them. 223 224 @li @ref nn::nfp::ResultNotFound 225 226 227 */ 228 NN_DEFINE_RESULT_CONST_RANGE( 229 ResultTagNotFound, 230 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 57728, 57728, 58240 231 ); 232 233 /*! 234 @class nn::nfp::ResultCharacterNotFound 235 @brief No character with the specified ID was found. Check that the ID is correct. 236 237 This result is subsumed by the following results and can be caught by handling any of them. 238 239 @li @ref nn::nfp::ResultNotFound 240 241 242 */ 243 NN_DEFINE_RESULT_CONST_RANGE( 244 ResultCharacterNotFound, 245 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 58240, 58240, 58752 246 ); 247 248 /*! 249 @class nn::nfp::ResultNeedRestore 250 @brief The tag content is corrupted. Call the <tt>@ref Restore</tt> function to use the existing backup data to restore the tag content. 251 252 */ 253 NN_DEFINE_RESULT_CONST_RANGE( 254 ResultNeedRestore, 255 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 64000, 64000, 65280 256 ); 257 258 /*! 259 @class nn::nfp::ResultNeedFormat 260 @brief The tag is corrupted. The tag content cannot be restored because there is no backup data. Prompt the user to initialize <tt>Cabinet</tt>. 261 262 */ 263 NN_DEFINE_RESULT_CONST_RANGE( 264 ResultNeedFormat, 265 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 65280, 65280, 66560 266 ); 267 268 /*! 269 @class nn::nfp::ResultNeedCreate 270 @brief The application area has not been created. Call the <tt>@ref CreateApplicationArea</tt> function to create the application area. 271 272 */ 273 NN_DEFINE_RESULT_CONST_RANGE( 274 ResultNeedCreate, 275 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 66560, 66560, 67840 276 ); 277 278 /*! 279 @class nn::nfp::ResultNeedRegister 280 @brief The common region has not been created. This must be registered in amiibo Settings. 281 282 */ 283 NN_DEFINE_RESULT_CONST_RANGE( 284 ResultNeedRegister, 285 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 67840, 67840, 69120 286 ); 287 288 /*! 289 @class nn::nfp::ResultAlreadyCreated 290 @brief The application area has already been created. 291 292 */ 293 NN_DEFINE_RESULT_CONST_RANGE( 294 ResultAlreadyCreated, 295 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 69120, 69120, 70400 296 ); 297 298 /*! 299 @class nn::nfp::ResultAccessIdMisMatch 300 @brief Cannot access the application area because the specified Access ID does not match the ID written to the tag. 301 302 */ 303 NN_DEFINE_RESULT_CONST_RANGE( 304 ResultAccessIdMisMatch, 305 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 70400, 70400, 71680 306 ); 307 308 /*! 309 @class nn::nfp::ResultNotBroken 310 @brief Tag data does not need to be restored because it is not corrupted. 311 312 */ 313 NN_DEFINE_RESULT_CONST_RANGE( 314 ResultNotBroken, 315 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 71680, 71680, 72960 316 ); 317 318 /*! 319 @class nn::nfp::ResultUidMisMatch 320 @brief UID mismatch. 321 322 */ 323 NN_DEFINE_RESULT_CONST_RANGE( 324 ResultUidMisMatch, 325 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 72960, 72960, 74240 326 ); 327 328 /*! 329 @class nn::nfp::ResultInvalidFormatVersion 330 @brief Unsupported format version. Notify the user that the application does not support this amiibo. 331 332 */ 333 NN_DEFINE_RESULT_CONST_RANGE( 334 ResultInvalidFormatVersion, 335 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 75520, 75520, 76800 336 ); 337 338 /*! 339 @class nn::nfp::ResultNoData 340 @brief The data does not exist. 341 342 */ 343 NN_DEFINE_RESULT_CONST_RANGE( 344 ResultNoData, 345 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 76800, 76800, 78080 346 ); 347 348 /*! 349 @class nn::nfp::ResultBackupError 350 @brief Failed to access backup data. 351 352 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 353 354 @li @ref nn::nfp::ResultNoBackupFile 355 @li @ref nn::nfp::ResultBackupOpenFailed 356 @li @ref nn::nfp::ResultBackupReadFailed 357 @li @ref nn::nfp::ResultBackupWriteFailed 358 359 360 */ 361 NN_DEFINE_RESULT_CONST_RANGE( 362 ResultBackupError, 363 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 230400, 230400, 243200 364 ); 365 366 /*! 367 @class nn::nfp::ResultNoBackupFile 368 @brief This API function cannot be called because there is no backup file. 369 370 This result is subsumed by the following results and can be caught by handling any of them. 371 372 @li @ref nn::nfp::ResultBackupError 373 374 375 */ 376 NN_DEFINE_RESULT_CONST_RANGE( 377 ResultNoBackupFile, 378 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 230528, 230528, 231040 379 ); 380 381 /*! 382 @class nn::nfp::ResultBackupOpenFailed 383 @brief Failed to open the backup file. 384 385 This result is subsumed by the following results and can be caught by handling any of them. 386 387 @li @ref nn::nfp::ResultBackupError 388 389 390 */ 391 NN_DEFINE_RESULT_CONST_RANGE( 392 ResultBackupOpenFailed, 393 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 231040, 231040, 231552 394 ); 395 396 /*! 397 @class nn::nfp::ResultBackupReadFailed 398 @brief Failed to load backup file data. 399 400 This result is subsumed by the following results and can be caught by handling any of them. 401 402 @li @ref nn::nfp::ResultBackupError 403 404 405 */ 406 NN_DEFINE_RESULT_CONST_RANGE( 407 ResultBackupReadFailed, 408 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 231552, 231552, 232064 409 ); 410 411 /*! 412 @class nn::nfp::ResultBackupWriteFailed 413 @brief Failed to write to the backup file. 414 415 This result is subsumed by the following results and can be caught by handling any of them. 416 417 @li @ref nn::nfp::ResultBackupError 418 419 420 */ 421 NN_DEFINE_RESULT_CONST_RANGE( 422 ResultBackupWriteFailed, 423 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 232064, 232064, 232576 424 ); 425 426 /*! 427 @class nn::nfp::ResultFailed 428 @brief The process failed. 429 430 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 431 432 @li @ref nn::nfp::ResultOperationFailed 433 @li @ref nn::nfp::ResultDataAccessFailed 434 435 436 */ 437 NN_DEFINE_RESULT_CONST_RANGE( 438 ResultFailed, 439 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 256000, 256000, 268800 440 ); 441 442 /*! 443 @class nn::nfp::ResultOperationFailed 444 @brief The requested operation failed. Check that you are using the API function correctly. 445 446 This result is subsumed by the following results and can be caught by handling any of them. 447 448 @li @ref nn::nfp::ResultFailed 449 450 451 */ 452 NN_DEFINE_RESULT_CONST_RANGE( 453 ResultOperationFailed, 454 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 256128, 256128, 256640 455 ); 456 457 /*! 458 @class nn::nfp::ResultDataAccessFailed 459 @brief Failed to access system data. 460 461 This result is subsumed by the following results and can be caught by handling any of them. 462 463 @li @ref nn::nfp::ResultFailed 464 465 466 */ 467 NN_DEFINE_RESULT_CONST_RANGE( 468 ResultDataAccessFailed, 469 nn::Result::LEVEL_FATAL, nn::RESULT_MODULE_NN_NFP, 256640, 256640, 257152 470 ); 471 472 /*! 473 @class nn::nfp::ResultNotImplemented 474 @brief Not implemented. 475 476 */ 477 NN_DEFINE_RESULT_CONST_RANGE( 478 ResultNotImplemented, 479 nn::Result::LEVEL_STATUS, nn::RESULT_MODULE_NN_NFP, 364800, 364800, 364928 480 ); 481 482 /*! 483 @class nn::nfp::ResultFatalError 484 @brief A fatal error has occurred. 485 486 Handling this <tt>Result</tt> object catches all of the following <tt>Result</tt> objects. 487 488 @li @ref nn::nfp::ResultUnexpected 489 490 491 */ 492 NN_DEFINE_RESULT_CONST_RANGE( 493 ResultFatalError, 494 nn::Result::LEVEL_FATAL, nn::RESULT_MODULE_NN_NFP, 371200, 371200, 383872 495 ); 496 497 /*! 498 @class nn::nfp::ResultUnexpected 499 @brief Unexpected error. A fatal system error may have occurred. 500 501 This result is subsumed by the following results and can be caught by handling any of them. 502 503 @li @ref nn::nfp::ResultFatalError 504 505 506 */ 507 NN_DEFINE_RESULT_CONST_RANGE( 508 ResultUnexpected, 509 nn::Result::LEVEL_FATAL, nn::RESULT_MODULE_NN_NFP, 383744, 383744, 383872 510 ); 511 512 513 514 515 //! @} 516 517 } // namespace nfp 518 } // namespace nn 519 520 #endif // __cplusplus 521 522 #endif // NN_NFP_NFP_RESULT_H_ 523