filex/test/regression_test/filex_unicode_fat_entry_test.c

/***************************************************************************/
/* Copyright (c) 2024 Microsoft Corporation                                */
/* Copyright (c) 2026 Eclipse ThreadX contributors                         */
/*                                                                         */
/* This program and the accompanying materials are made available under    */
/* the terms of the MIT License which is available at                      */
/* https://opensource.org/licenses/MIT.                                    */
/*                                                                         */
/* SPDX-License-Identifier: MIT                                            */
/***************************************************************************/

/* Test the condition of fat entry broken. */
#include   "fx_api.h"
#include   "fx_ram_driver_test.h"
#include   <stdio.h>

#define     DEMO_STACK_SIZE         8192
#define     CACHE_SIZE              16*128

#ifndef FX_STANDALONE_ENABLE

/* Define the ThreadX and FileX object control blocks...  */

static TX_THREAD                ftest_0;
static FX_MEDIA                 ram_disk;

/* Define the counters used in the test application...  */

static UCHAR                    *ram_disk_memory;
static UCHAR                    *cache_buffer;

/* Define thread prototypes.  */

void    filex_unicode_fat_entry_test_application_define(void *first_unused_memory);
static void    ftest_0_entry(ULONG thread_input);

VOID  _fx_ram_driver(FX_MEDIA *media_ptr);
void  test_control_return(UINT status);

/* Define what the initial system looks like.  */

#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void    filex_unicode_fat_entry_test_application_define(void *first_unused_memory)
#endif
{

UCHAR    *pointer;


    /* Setup the working pointer.  */
    pointer =  (UCHAR *) first_unused_memory;

    /* Create the main thread.  */
    tx_thread_create(&ftest_0, "thread 0", ftest_0_entry, 0,
            pointer, DEMO_STACK_SIZE,
            4, 4, TX_NO_TIME_SLICE, TX_AUTO_START);
    pointer =  pointer + DEMO_STACK_SIZE;

    /* Setup memory for the RAM disk and the sector cache.  */
    cache_buffer =  pointer;
    pointer =  pointer + CACHE_SIZE;
    ram_disk_memory =  pointer;

    /* Initialize the FileX system.  */
    fx_system_initialize();
}


/* Define the test threads.  */

static void    ftest_0_entry(ULONG thread_input)
{

UINT        status;
UCHAR       destination_name[100] = {0};
UCHAR       destination_name2[100] = {0};
UCHAR       long_unicode_name[] =   {2, 0, 3, 0, 4, 0, 5, 0, 6, 0, 7, 0, 8, 0, 9, 0, 10, 0, 11, 0, 12, 0, 13, 0, 14, 0, 15, 0, 0, 0};
ULONG       length = 14;
FX_LOCAL_PATH   local_path;

    FX_PARAMETER_NOT_USED(thread_input);

    /* Print out some test information banners.  */
    printf("FileX Test:   Unicode fat entry test.................................");

    /* Format the media.  This needs to be done before opening it!  */
    status =  fx_media_format(&ram_disk,
                            _fx_ram_driver,         // Driver entry
                            ram_disk_memory,        // RAM disk memory pointer
                            cache_buffer,           // Media buffer pointer
                            CACHE_SIZE,             // Media buffer size
                            "MY_RAM_DISK",          // Volume Name
                            1,                      // Number of FATs
                            32,                     // Directory Entries
                            0,                      // Hidden sectors
                            512,                    // Total sectors
                            128,                    // Sector size
                            1,                      // Sectors per cluster
                            1,                      // Heads
                            1);                     // Sectors per track

    /* Open the ram_disk.  */
    status +=  fx_media_open(&ram_disk, "RAM DISK", _fx_ram_driver, ram_disk_memory, cache_buffer, CACHE_SIZE);
    status += fx_unicode_directory_create(&ram_disk,  long_unicode_name, length, (CHAR *) destination_name);

    /* Chdir to the created directory and create a subdirectory. */
    status += fx_directory_local_path_set(&ram_disk, &local_path, (CHAR *)destination_name);
    status += fx_unicode_directory_create(&ram_disk,  long_unicode_name, length, (CHAR *) destination_name2);

    /* Fat entry destory. */
    ram_disk.fx_media_fat_cache[8].fx_fat_cache_entry_value = 0;
    ram_disk.fx_media_fat_cache[8].fx_fat_cache_entry_dirty = 1;

    /* Close the media to flush buffer. Now we have a disk with a corrupt dir_entry. */
    status += fx_media_close(&ram_disk);

    /* Open the ram_disk.  */
    status +=  fx_media_open(&ram_disk, "RAM DISK", _fx_ram_driver, ram_disk_memory, cache_buffer, CACHE_SIZE);
    return_value_if_fail( status == FX_SUCCESS, 2);

    /* Attempt to access our broken directory. */
    status = fx_directory_local_path_set(&ram_disk, &local_path, (CHAR *)destination_name);
    return_value_if_fail( status == FX_INVALID_PATH, 3);
    status = fx_unicode_directory_create(&ram_disk,  long_unicode_name, length, (CHAR *) destination_name);
    return_value_if_fail( status == FX_LOST_CLUSTER_ERROR, 4);

    printf("SUCCESS!\n");
    test_control_return(0);
}

#else

extern void    test_control_return(UINT status);
#ifdef CTEST
void test_application_define(void *first_unused_memory)
#else
void    filex_fault_tolerant_enable_4_test_application_define(void *first_unused_memory)
#endif
{

    FX_PARAMETER_NOT_USED(first_unused_memory);

    /* Print out some test information banners.  */
    printf("FileX Test:   Unicode fat entry test.................................N/A\n");

    test_control_return(255);
}
#endif