FlashAir™ Developers
Common Commands
Last update: March 2015
| Command ID | Function Name | Description |
|---|---|---|
| 0011h | SetCurrentTime(currentDate, currentTime) | Sets the current time from a Host to a Card. |
| 0012h | Abort(sequenceID) | Aborts the process of the specified iSDIO command. |
| 0013h | ReadResponse(sequenceID) | Reads the specified Response Data from the Response Data Register Port. |
| 0014h | SetPowerSaveMode(powerMode) | Sets the Power Save mode to a Card (on/off). |
| 0015h | SetChannel(channelNum) | Set the channel to a Card for AP. |
SetCurrentTime(currentDate, currentTime)
A Host requests to set the current time to a Card. The Card counts up from the specified value by the Card’s internal clock, and the time is used for a Card to set the time stamp of a file or a directory when the Card creates, modifies or accesses it.
Command ID
0011h
Arguments
| Name | Type | Size | Description |
|---|---|---|---|
| currentDate | integer (little endian) | 2-byte |
The ‘currentDate’ is the date to be set to a Card. The format is as follows;
|
| currentTime | integer (little endian) | 2-byte |
The ‘currentTime’ is the time to be set to a Card. The format is as follows;
|
Response
None.
Abort(sequenceID)
A Host requests to terminate the specified iSDIO command processing. When a Card receives this command, the Card should behave as if the current processed command was not issued. However, as for a command which creates a file in the NAND memory module (i.e. "SendHTTPMessageByFile", "SendHTTPFileByFile", "SendHTTPSSLMessageByFile", "SendHTTPSSLFileByFile", "DLNA_AcceptUpload", "GetFile" and "PTP_ReceiveFile" commands), the Card doesn’t have to remove the file even though the process is not completely finished. This means the file may not have all of the data to be stored. Therefore, a Host should treat this incomplete file appropriately after abort process. Moreover, note that the Card shall keep the consistency of file system metadata (File Allocation Table, Directory Entry, etc.). This command is processed prior to the current processed command if accepted, and the Command Response Status for this command is not registered in the Command Response Status Queue but Command Response Status for the aborted command is changed to "04h: Process Terminated". That is, any command statuses are not removed from the queue though this command is issued. If the multiple commands are processed and one command is aborted, the other commands are not affected and continue to be processed.
Depending on an issued timing of this command, this command may be ignored and the target command to be aborted may be processed completely. That is, Command Response Status for the target command may become "03h: Process Succeeded" or "80h to FFh: Process Failed". Note that processing time of "Abort" command shall be kept even in this case.
Note that it is strongly recommended to use "Disconnect" command to terminate the wireless LAN connection or the Peer-to-Peer File Transfer Application.
Command ID
0012h
Arguments
| Name | Type | Size | Description |
|---|---|---|---|
| sequenceID | integer | 4-byte | The ‘sequenceID’ is the iSDIO command sequence id of the command, which is specified by a Host when the command is issued. This value shall be "00 00 00 00h" to "FF FF FF FFh". |
Response
None.
ReadResponse(sequenceID)
A Host requests to read a Response Data corresponding to the issued command by specifying the iSDIO command sequence id. The Response Data is available from the Response Data Register Port unless the buffer is overflow. This command is valid only when the specified command has been processed successfully and is in the Command Response Status Queue. In addition, this command is processed prior to the current processed command, and the Command Response Status for this command is not registered in the Command Response Status Queue. That is, any command statuses are not removed from the queue though this command is issued.
Command ID
0013h
Arguments
| Name | Type | Size | Description |
|---|---|---|---|
| sequenceID | integer | 4-byte | The ‘sequenceID’ is the iSDIO command sequence id of the command, which is specified by a Host when the command is issued. This value shall be "00 00 00 00h" to "FF FF FF FFh". |
Response
The Response Data depending on the specified iSDIO command (See 2.2.2.3 iSDIO Command Response Data in [iSDIO]).
Note that by default the Response Data for the Command Response Status #1 in the first command in the Command Response Status Queue is mapped to the Response Data Register Port. And as for the other Command Response Statuses (#2 to #8), this command needs to be issued to map the specified Response Data to the Response Register Port (If a Host issues only one iSDIO command in the Command Write Data without using the queue scheme, the Host is unnecessary to use this command). This command is also able to be issued to map the Response Data for the Command Response Status #1.
Also note that even though this command is issued before the reading of the current Response Data is completed, the new Response Data is able to be read from the beginning of the data. That is, if the same command as current one is specified by this command before the reading of the current Response Data is completed, the Response Data is able to be read from the beginning.
SetPowerSaveMode(powerMode)
A Host requests to change the Power Save mode of a Card. If the mode is ‘on’, a Card works in Power Save mode (It depends on a Card implementation how to realize the power saving in a Card however some other performance such as the data transfer throughput may become lower in this mode depending on the Card).
Command ID
0014h
Arguments
| Name | Type | Size | Description |
|---|---|---|---|
| powerMode | integer | 1-byte |
The ‘powerMode’ denotes the Power Save mode.
|
Response
None.
SetChannel(channelNum)
A Host requests to set the channel in the AP to a Card. Note that if a Card doesn’t support the selected channel, this command is rejected. A Host needs to check the "Channel Support" in the Capability Register. See 3.5 iSDIO Capability Register for Wireless LAN.
Command ID
0015h
Arguments
| Name | Type | Size | Description |
|---|---|---|---|
| channelNum | integer | 1-byte |
The ‘channelNum’ denotes the number of the Channel.
|
Response
None.