1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: boss_Lib.h 4 Copyright (C)2009 Nintendo Co., Ltd. All rights reserved. 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 $Rev: 37899 $ 11 *--------------------------------------------------------------------------- 12 13 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 */ 51 nn::Result Initialize(void); 52 53 /* Please see man pages for details 54 55 56 57 58 59 60 */ 61 nn::Result Finalize(void); 62 63 /* Please see man pages for details 64 65 66 67 68 69 70 71 72 73 74 75 */ 76 nn::Result RegisterPrivateRootCa(const u8* pCertData, size_t certDataSize); 77 78 /* Please see man pages for details 79 80 81 82 83 84 85 86 87 88 89 90 91 92 */ 93 nn::Result RegisterPrivateClientCert(const u8* pCertData, size_t certDataSize 94 , const u8* pPrivateKeyData, size_t privateKeyDataSize); 95 96 /* Please see man pages for details 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 nn::Result RegisterTask(Task* pTask, TaskPolicy* pPolicy , TaskAction* pAction 149 , TaskOption* pOption=NULL 150 , u8 taskStep=DEFAULT_STEP_ID); 151 152 /* Please see man pages for details 153 154 155 156 157 158 159 160 161 162 163 164 165 166 */ 167 nn::Result UnregisterTask(Task* pTask, u8 taskStep=DEFAULT_STEP_ID); 168 169 /* Please see man pages for details 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 */ 187 nn::Result ReconfigureTask(Task* pTask, TaskPolicy* pPolicy, u8 taskStep=DEFAULT_STEP_ID); 188 189 /* Please see man pages for details 190 191 192 193 194 195 196 197 198 199 200 201 */ 202 nn::Result GetTaskIdList(TaskIdList* pTaskIdList); 203 204 /* Please see man pages for details 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 */ 221 nn::Result GetStepIdList(const char* pTaskId, StepIdList* pStepIdList); 222 223 /* Please see man pages for details 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 nn::Result RegisterStorage(bit32 storageId, size_t storageSize, nn::boss::StorageType storageType=nn::boss::USER_EXT_SAVEDATA_STORAGE); 261 262 /* Please see man pages for details 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 nn::Result RegisterStorage(bit32 storageId, size_t storageSize, u16 entryCount, nn::boss::StorageType storageType=nn::boss::USER_EXT_SAVEDATA_STORAGE); 301 302 /* Please see man pages for details 303 304 305 306 307 308 309 310 */ 311 nn::Result UnregisterStorage(void); 312 313 314 /* Please see man pages for details 315 316 317 318 319 320 321 322 323 */ 324 nn::Result GetStorageInfo(size_t* pStorageSize=NULL); 325 326 /* Please see man pages for details 327 328 329 330 331 332 333 334 335 336 */ 337 nn::Result GetStorageInfo(size_t* pStorageSize, u16* pEntryCount); 338 339 /* Please see man pages for details 340 341 342 343 344 345 346 347 348 349 350 351 352 353 */ 354 nn::Result GetNewArrivalFlag(bool* pFlag); 355 356 /* Please see man pages for details 357 358 359 360 361 362 363 364 365 366 367 368 369 */ 370 nn::Result RegisterNewArrivalEvent(nn::os::Event* event); 371 372 /* Please see man pages for details 373 374 375 */ 376 nn::Result GetNewArrivalEvent(nn::os::Event* event) NN_ATTRIBUTE_DEPRECATED; 377 378 /* Please see man pages for details 379 380 381 382 383 384 385 386 387 388 389 */ 390 nn::Result SetOptoutFlag(bool flag); 391 392 /* Please see man pages for details 393 394 395 396 397 398 399 400 401 402 */ 403 nn::Result GetOptoutFlag(bool* pFlag); 404 405 /* Please see man pages for details 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 nn::Result GetNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 441 442 /* Please see man pages for details 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 */ 464 nn::Result GetOwnNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 465 466 /* Please see man pages for details 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 */ 489 nn::Result GetNewDataNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 490 491 /* Please see man pages for details 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 */ 514 nn::Result GetOwnNewDataNsDataIdList(u32 dataType, NsDataIdList* pNsDataId); 515 516 517 /* Please see man pages for details 518 519 520 521 522 523 524 525 526 527 528 529 */ 530 nn::Result GetErrorCode( u32* pOut, TaskResultCode targetResult ); 531 532 } // end of namespace boss 533 } // end of namespace nn 534 535 #endif // __cplusplus 536 537 #endif /* NN_BOSS_BOSS_LIB_H_ */ 538