File System

Most connected applications require the ability to store configuration information or cache local data. ZentriOS provides a reliable read/write filesystem and access to extended and bulk flash storage to satisfy application storage requirements.

Zentri Wi-Fi modules contain a microprocessor with internal flash and an extended (on module) serial flash. An additional (optional) bulk serial flash is also supported. See Flash Storage. For third-party devices running ZentriOS, an extended serial flash must be provided to store temporary files and to enable wireless OTA updates.

Commands are available to create, delete and open files, and file contents can be easily accessed using one or more stream commands.

Here's a quick example showing how to create, manipulate then delete a file:

> file_create     hello.txt 12
Hello World!

Success
> file_open       hello.txt
0
> stream_read     0 3
Hel
> stream_read     0 50
lo World!
> file_delete     hello.txt
Success

<- Create file, length 12 bytes
<- Enter file contents
  (echoed if system.cmd.echo = 1)

<- Open file for reading
(ZentriOS returns file stream handle = 0)
<- Read no more than 3 bytes

<- Read no more than 50 bytes
  (close file if EOF reached)
<- Delete file

When a file is open, ZentriOS creates a file stream and returns a file stream handle to be used as an argument of the stream_read command. See Network Connections and Streams. The stream type is FILE.

Listing Files

To list files, use the ls command.

To obtain a verbose listing of all files on the MCU-internal flash, bulk and extended serial flash, use the ls command with the -v option. Users are only permitted to write files to serial flash.

> ls -v
!  # Type  Flags  Hnd    Size    Version  Filename
#  0 e-FE   0001   73    1853   2.0.0.11  /favicon.ico.gz
#  1 e-FE   0001   68   18067   2.0.0.11  webapp/images.png
#  2 e-FE   0001   52   10525   2.0.0.11  webapp/index.css.gz
#  3 e-FE   0001   65   10155   2.0.0.11  webapp/index.html
#  4 e-FE   0001   55   39247   2.0.0.11  webapp/index.js.gz
#  5 e-FB   0001   74   36511    2.0.1.8  command_help.csv
#  6 e-FD   0001   51     135   2.0.0.11  default_setup.script
#  7 e-03   0001   50    1236   2.0.0.11  geotrust_ca.pem
#  8 e-FE   0021   84    2074    1.0.0.0  my_ca.pem
#  9 i-00   001B    0  212736    2.0.1.8  sys/kernel.bin
# 10 i-81   001B   52  178252    2.0.1.8  sys/services.bin
# 11 e-01   0009    0  203261  5.26.230.3  sys/wifi_fw.bin
# 12 b-FE   0021   25 1995261    2.1.0.0  DSC20564.JPEG

File Types

In the ls file listing, Type column, a prefix indicates the location of the file in internal, bulk or extended flash:

• i - MCU internal flash
• e - extended serial flash
• b - bulk serial flash

See Flash Storage below.

For example, e-FE indicates a file in extended serial flash with a file type of 0xFE.

File types are used internally by ZentriOS for file management.

ZentriOS file types are enumerated in the following table.

Custom User Types

The type range from 0x96 (decimal 150) to 0xC7 (decimal 199) is set aside for custom types. Use types in this range for file management specific to your application.

File Flags

Flags are displayed in the file listing in hex format, without a 0x prefix.

The flags correspond to bits as follows:

Only the Essential and the Unprotected flags can be explicitly set using a command.

The file_create and http_download commands provide -e and -u options to set the Essential and Unprotected flags.

Examples:

File Version

For files that form part of the ZentriOS system, such as services.bin and kernel.bin, the file version follows the scheme:

<major>.<minor>.<patch>.<release_candidate>

When creating a user file, the user can choose the versioning scheme. The file_create and http_download commands provide a version option to set the version.

File Checksum

The checksum used on individual files is calculated using a CCITT CRC-16 algorithm with polynomial 0x1021. The full set of CRC parameters is as follows:

See the crc_zentrios.py python script and the crccitt_test.c C source for demonstrations of calculating the CRC.

The file_create and http_download commands provide an option to set the CRC.

You can view a file CRC with the file_stat command. The CRC is the second item in the comma-separated list.

See also the File System application note.

File Names

File names are case sensitive, and can contain a maximum of 95 characters from the set:

A-Za-z0-9~!@#$%^&*()_+#.{}[]`=:;|\/'-.

That is, a file name can contain any character except for the double quote character. A double quote results in a parse error when creating a file with the file_create command.

It may be possible to create a file with a double quote character using other means, then download the file to the device flash.

The ZentriOS file system does not treat the . character or the / character differently to any other. These can be used to create pseudo extensions and pseudo folders. The web app recognizes the / character for folder emulation, which makes some file manipulations more convenient. See ZentriOS Web App, Folder Emulation.

Web app folder emulation creates some restrictions on where you can place a / character in a file name. These apply only to files manipulated in the Web App Files tab.

Special Files

Some files with special functions are listed in the following table:

Writing Files

There are two ZentriOS commands that can write to the file system:

• file_create
• http_download

There are several ways to invoke these commands:

• Via the ZentriOS Web App. This is the simplest way to manage files manually.
• Manually, via a ZentriOS terminal or a remote terminal
• Under programmed MCU host control
• Via the HTTP Server RESTful API

Writing with the Web App File Browser

When you open the ZentriOS Web App in a web browser and select the Files tab, you can load files to the device file system using click and browse, or drag and drop.

In the background, the ZentriOS Web App uses the file_create command to write files to the device file system, using the HTTP Server RESTful API.

There are several ways to activate the ZentriOS Web App. See ZentriOS Web App.

Writing with the Terminal

In the ZentriOS terminal or remote terminal, use the file_create command to create the file. Immediately after issuing the command, type the file contents, or alternatively copy and paste the file contents into the terminal after issuing the fcr command. The length of the file must be supplied. The character count includes any line termination characters.

In the example below we create a script that can be run using the command setup cmd -v test.script. In this case the character count is 35.

> fcr test.script 35
help,setup,\r\n#This is a comment

File created
Success

Writing File Contents in Chunks

You can write the file in chunks by leaving the file open after issuing the file_create with the -o option. Write the file chunks to the stream returned by the file_create command. You must know the total size of the file to be created in advance.

When you open the file, ZentriOS returns a stream handle, to be used as an argument of the stream_write command. See Network Connections and Streams.

In the example below a small file is created in two chunks:

> file_create -o hello.txt 11
[Opened: 0]
0
> stream_write 0 6
Hello
Success
> stream_write 0 5
World
File created
[Closed: 0]
Success
> file_open hello.txt
[Opened: 0]
0
> stream_read 0 1000
Hello World
[Closed: 0]

Create file; leave stream open; specify total length

Response: open stream and return stream handle
Write first chunk; specify chunk length
Send chunk content (includes trailing space)

Write second chunk; specify chunk length
Send chunk content

Stream closed

Open new file

Response: open stream and return stream handle
Read contents

Stream closed

HTTP Download

You can also provide the file for download from a web server accessible to the device, and use the http_download command. For example:

> http_download http://www.google.com.au/images/srpr/logo11w.png test1.png
Downloading: test1.png to flash file system
Request GET /images/srpr/logo11w.png
Connecting (http): www.google.com.au:80
HTTP response: 200
Success
> ls
!  #   Size   Version  Filename
…
#  4  14022     1.0.0  test1.png
…

OTA

OTA wireless updates allow you to update the ZentriOS system files automatically from Zentri OTA update servers online. Please contact Zentri if you need custom hosting services for your application firmware or files.

Reading Files

The following ZentriOS commands can write to the file system:

• file_open
• http_upload

There are several ways to invoke these commands:

• Via the ZentriOS Web App. This is the simplest way to manage files manually.
• Manually, via a ZentriOS terminal or a remote terminal
• Under programmed MCU host control
• Via the HTTP Server RESTful API

Reading with the Web App File Browser

When you open the ZentriOS Web App in a web browser and select the Files tab, you can download a file from the device file system by clicking the file name.

In the background, the ZentriOS Web App uses the file_open command to read the files from the device file system, using the HTTP Server RESTful API.

There are several ways to activate the ZentriOS Web App. See ZentriOS Web App.

Reading from a Terminal

You can read text files directly from the ZentriOS Terminal or remote terminal. Read the file, using a file_open followed by a stream_read command, specifying the stream index returned from the file open, e.g.:

> fop default_setup.script
[Opened: 0]
0
> read 0 1000
network_up,-s    ,Configuration network credentials
set wlan.auto_join.enabled,true,Enable network auto-join
save,-,Saving settings

[Closed: 0]

HTTP Upload

You can upload the file to an available web server with file upload capability with the http_upload command.

Flash Storage

A ZentriOS device contains internal flash inside the microprocessor and an extended flash chip for user storage.

Extended flash is serial flash. Internal flash cannot be manipulated by ZentriOS commands.

Flash Wear Leveling

The flash wear leveling feature ensures that all sectors on the extended/bulk flash are evenly used. This allows for maximum file writes to the extended/bulk flash. This system works seamlessly in the background, and requires no user activity.

The file sys/wl_table.bin is used by the flash wear leveling feature.

Bulk Flash

In addition, an external serial flash can be connected to the device using the existing sflash GPIOs. This is referred to as bulk flash. To enable access to bulk flash, configure the chip select GPIO with the system.bflash.cs_gpio variable.

By default ZentriOS can support up to 128MB bulk flash.

All OTA files and config files (created by the save command) are always stored on extended flash regardless of whether the bulk flash is enabled.

The following commands operate on bulk flash if available, otherwise on extended flash:

• http_download - saves file to bulk flash if available, otherwise to extended flash
• file_create - with no options, saves file to bulk flash if available, otherwise to extended flash. Use the --extended and --bulk options to specify creating the file on bulk or extended flash
• file_open - opens file if found on bulk flash, otherwise on extended flash
• file_delete - deletes file if found on bulk flash, otherwise on extended flash

Extended and bulk flash can be formatted with the format_flash command.

Supported Bulk Flash Chips

Serial flash chips currently supported by ZentriOS are as follows:

If you require support for a serial flash chip not listed in the table above, please contact Zentri.

Connecting Bulk Serial Flash to the Device

The ZentriOS device is the SPI master. The bulk sflash is the SPI slave.

Connecting bulk sflash to the device requires 4 signals. The GPIO numbers vary depending on the device, as follows:

Use the format_flash bulk command to erase the contents of the sflash.

The bulk sflash uses the same SPI bus as the extended serial flash on-board the module. Thus the SPI parameters (clock speed, polarity, etc) are not configurable.

Encrypting ZentriOS Files

The python script crypto_util.py demonstrates encrypting and decrypting files which can be used by ZentriOS.

Encrypted File Format

A ZentriOS encrypted file has the following format:

• 32 byte 'header':
  • 16 byte Initialization Vector (IV), used to do the AES CBC encryption
  • 16 byte Hash Message Authentication Code (HMAC), used to verify the decrypted data
• Encrypted file data

So an encrypted file is always 32 bytes longer than a file with same contents unencrypted.

Encryption Sequence

The sequence for encrypting a file is as follows:

1. Generate Initialization Vector (IV)
2. Initialize AES-128 context with the user AES key
3. Calculate the Cipher Block Chaining (CBC) of the entire file, IV=0, and pad with 0s to 16 bytes if necessary, the last 16 bytes of the encrypted output is used as the HMAC
4. Write the initial IV (the IV from step 1) to the output file/buffer
5. Using the IV from step 1 and AES-128 context from step 2, using CTR mode encrypt HMAC and write to output file/buffer
6. Using IV from step 5 and AES-128 context from step 2, using CTR mode encrypt file contents and write to output file/buffer

Decryption Sequence

The sequence for decrypting a file is as follows:

1. Initialize AES-128 context with the user AES key
2. Read the 16 byte IV from the beginning of the encrypted file
3. Read the 16 bytes encrypted HMAC from the file
4. Using the AES context from Step 1 and the IV from Step 2, decrypt the HMAC using AES CTR mode
5. Using the AES context and IV from step 4, decrypt the rest of the file using AES CTR mode
6. Calculate the Cipher Block Chaining (CBC) of the decrypted file data from step 5, IV=0, and pad with 0s to 16 bytes if necessary
7. The final block from step 6 should match the HMAC from step 4. If the two 16 byte values don't match then either the given user key is invalid or the encrypted file is corrupted.

Preventing File Corruption

The ZentriOS file system is designed to be resistant to file corruption. A file does not appear in the file system until it is marked as valid. See File Flags. A file is marked as valid only after all file data is written and validated. When a file is not valid, it cannot be listed with the ls command or opened with the file_open command. A valid file may not be modified. That is, file size and contents cannot be modified after the file is created.

This ensures the file system does not become populated with corrupt files due to sudden power loss, reset, or interruption of the file stream during writing.

The steps in file creation are as follows:

• A file is created with the specified size.
• The file data is then written.
• Once all the data is written, the file contents are validated and the file's valid flag is set to true.

If the module is reset or power cycled, or the file stream is manually closed before the valid flag is set, the created file and any written contents are lost.

Once the valid flag is set, the file may not be modified.