am.h

Go to the documentation of this file.

#pragma once

/*
    Requires access to "am:net" or "am:u" service
*/

Result amInit();
Result amExit();

/* AM_GetTitleCount()
About: Gets the number of titles for a given mediatype

  mediatype     mediatype to get titles from
  count         ptr to store title count
*/
Result AM_GetTitleCount(u8 mediatype, u32 *count);

/* AM_GetTitleList()
About: Writes a titleid list for a mediatype to a buffer

  mediatype     mediatype to get list from
  count         number of titleids to get
  buffer        buffer to write titleids to
*/
Result AM_GetTitleList(u8 mediatype, u32 count, void *buffer);

/* AM_GetDeviceId()
About: Gets a 32bit device id, it's used for some key slot inits

  device_id     ptr to where the device id is written to
*/
Result AM_GetDeviceId(u32 *deviceid);

/**** Title Install Methods ****/
/* AM_StartCiaInstall()
About: Inits CIA install process, the returned ciahandle is where the data for CIA should be written to

  mediatype     mediatype to install CIA to
  ciahandle     ptr to where the handle should be written to
*/
Result AM_StartCiaInstall(u8 mediatype, Handle *ciahandle);

/* AM_StartDlpChildCiaInstall()
About: Inits CIA install process, the returned ciahandle is where the data for CIA should be written to
Note: This is for installing DLP CIAs only, mediatype is hardcoded to be NAND

  ciahandle     ptr to where the handle should be written to
*/
Result AM_StartDlpChildCiaInstall(Handle *ciahandle);

/* AM_CancelCIAInstall()
About: Abort CIA install process

  ciahandle     ptr to cia Handle provided by AM
*/
Result AM_CancelCIAInstall(Handle *ciahandle);

/* AM_FinishCiaInstall()
About: Once all data is written to the cia handle, this command signals AM to proceed with CIA install.
Note: AM closes the cia handle provided here

  mediatype     same mediatype specified ciahandle was obtained
  ciahandle     ptr to cia Handle provided by AM
*/
Result AM_FinishCiaInstall(u8 mediatype, Handle *ciahandle);

/**** Title Delete Methods ****/
/* AM_DeleteTitle()
About: Deletes any title on NAND/SDMC
Note: AM closes the cia handle provided here

  mediatype     mediatype of title
  titleid       title id of title
*/
Result AM_DeleteTitle(u8 mediatype, u64 titleid);

/* AM_DeleteAppTitle()
About: Deletes any title on NAND/SDMC
Note: If the title has the system category bit set, this will fail

  mediatype     mediatype of title
  titleid       title id of title
*/
Result AM_DeleteAppTitle(u8 mediatype, u64 titleid);

/* AM_InstallFIRM()
About: Installs FIRM to NAND (firm0:/ & firm1:/) from a CXI
Note: The title must have the uniqueid: 0x00000, otherwise this will fail.

  mediatype     mediatype of title
  titleid       title id of title
*/
Result AM_InstallFIRM(u8 mediatype, u64 titleid);