fs_func_async.c 30.4 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 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 261 262 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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 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 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 *   fs_func_async.c
 *
 * Project:
 * --------
 *   Maui_Software
 *
 * Description:
 * ------------
 *   This file provides MTK file system internal definitions.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/

#if !defined(__SMART_PHONE_MODEM__)

#include "kal_general_types.h"
#include "fs_internal_def.h"
#include "fs_gprot.h"
#include "fs_kal.h"
#include "app_ltlcom.h"         // for ILM (construct_local_param ...)
#include "stack_ltlcom.h"       // for ILM (allocate_ilm ...)
#include "stack_config.h"       // for module_type
#include "kal_release.h"        // for stack lib
#include "fs_internal_api.h"    // for FS lib
#include "fs_task.h"            // for JOB ID bitmap...etc.
#include "cache_sw.h"           // (strange!) without this, 10A.W10.50 will be failed because CPU_CACHE_LINE_SIZE is undefined ..
#include "fs_trc.h"
#include "fs_utility.h"

#define fs_assert_local(expr) fs_assert(expr, fs_func_async_c)
#define fs_ext_assert_local(expr, e1, e2, e3) fs_ext_assert(expr, fs_func_async_c, e1, e2, e3)
#define fs_util_trace_err_noinfo(error_code) fs_util_trace_err_slim(error_code, fs_func_async_c, __LINE__)

#if defined(__FS_ASYNC_SUPPORT_TASK__)

extern fs_job_id       _gfs_job_running_id;
extern fs_job_struct   *_gfs_job_running;
extern kal_bool fs_job_check_job_list(fs_job_struct *exist_job);
extern void fs_job_check_job_list_dump(void);

//----------------------------------
//   Internal API Declarations
//----------------------------------

static kal_int32   fs_async_int_initialize_job(fs_job_struct **job, fs_overlapped_struct *overlapped);
static void        fs_async_int_register_job(fs_job_struct *job, kal_uint32 msg_id);
static void        fs_async_int_send_msg(kal_int32 msg_id, void *local_para_ptr);

#define FS_ASYNC_INTERNAL_API

static void fs_async_int_send_msg(kal_int32 msg_id, void *local_para_ptr)
{
    ilm_struct  *ilm_ptr;
    module_type src_id;

    src_id = stack_get_active_module_id();

    ilm_ptr = allocate_ilm(src_id);
    ilm_ptr->src_mod_id     = src_id;
    ilm_ptr->dest_mod_id    = MOD_FS;
    ilm_ptr->sap_id         = FS_SAP;
    ilm_ptr->msg_id         = (msg_type)msg_id;
    ilm_ptr->local_para_ptr = (local_para_struct*)local_para_ptr;
    ilm_ptr->peer_buff_ptr  = NULL;

    msg_send_ext_queue(ilm_ptr);
}

static kal_int32 fs_async_int_initialize_job(fs_job_struct **job, fs_overlapped_struct *overlapped)
{
    fs_job_id       id;
    fs_job_struct   *j;
    kal_int32       result;

    // request a Job ID (valid value is > 0)
    if ((result = fs_job_alloc_id(&id, overlapped)) < 0)
    {
        return result;
    }

    j = *job = overlapped->buf; // job memory comes from user

    j->id       = id;
    j->state    = FS_JOB_STATE_NOT_STARTED;
    j->response_flag = overlapped->response_flag;
    j->callback = overlapped->callback;
    j->param    = overlapped->param;
    j->result   = FS_ABORTED_ERROR;
    j->mod_id   = stack_get_active_module_id();
    j->next     = NULL;

    if (overlapped->priority == FS_PRIORITY_DEFAULT)
        j->priority = _gfs_task_default_priority;
    else if (overlapped->priority == FS_PRIORITY_INHERITED)
        j->priority = kal_get_current_task_priority();
    else if (overlapped->priority == FS_PRIORITY_ASSIGN)
        j->priority = overlapped->priority_value - 1;
    else
        return FS_PARAM_ERROR; // invalid priority

    return (kal_int32)id;
}

static void fs_async_int_register_job(fs_job_struct *job, kal_uint32 msg_id)
{
    fs_job_req_struct   *req;

    // construct local parameter
    req = (fs_job_req_struct*)construct_local_para(sizeof(fs_job_req_struct), TD_RESET);
    req->job    = job;
    req->type   = FS_JOB_TYPE_ASYNC_API;
    job->next   = NULL;

    // adjust FS task's priority
    fs_task_priority_change(job->priority, FS_TASK_PRIORITY_CHANGE_DEFAULT);

    fs_util_trace_info4(TRACE_FUNC, FS_API_FS_ASYNC_JOB_REGISTER, (kal_uint32)job->id, (kal_uint32)job, (kal_uint32)job->state, (kal_uint32)job->api, NULL);
    fs_job_check_job_list(job);
    if (job==_gfs_job_running)  {
        fs_util_trace_info1(TRACE_ERROR, FS_API_FS_ASYNC_JOB_LIST_ERROR_JOBPTR_RUNNING, (kal_uint32)job, NULL);
        fs_job_check_job_list_dump();
        fs_assert_local(0);
    }

    // send message to FS task
    fs_async_int_send_msg(msg_id, (void *)req);
}

#define FS_ASYNC_EXPORTED_API

kal_int32 fs_async_abort_ex(fs_job_id job_id, void *buf)
{
    fs_job_abort_struct *job=(fs_job_abort_struct*)buf;

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_ABORT_S, job_id, NULL);

    if (job_id <= 0)    {
        fs_util_trace_err_noinfo(FS_ERR_INVALID_JOB_ID);
        return FS_ERR_INVALID_JOB_ID;
    }

    if (job!=NULL)  {
        if (job_id!=job->id)    {
            return FS_ERR_INVALID_JOB_ID;
        }
    }

    if (fs_job_abort_ex(job_id, buf)==KAL_TRUE) {
        return FS_NO_ERROR;
    }

    return FS_ERR_ASYNC_JOB_NOT_FOUND;
}

kal_int32 fs_async_abort(fs_job_id job_id)
{
    return fs_async_abort_ex(job_id, NULL);
}

kal_int32 fs_async_delete(const kal_wchar* filename, fs_overlapped_struct *overlapped)
{
    kal_int32               id;
    fs_job_delete_struct    *job;

    fs_util_trace_info1(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_DELETE_S, overlapped->priority, (void*)filename);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->filename = filename;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_DELETE;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_DELETE_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_DELETE_E, id, NULL);

    return id;
}

kal_int32 fs_async_find_first(const kal_wchar *name_pattern,
                              kal_uint8 attr, kal_uint8 attr_mask,
                              FS_DOSDirEntry *file_info, kal_wchar *file_name, kal_uint32 max_length,
                              fs_overlapped_struct *overlapped)
{
    kal_int32                   id;
    fs_job_find_first_struct    *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_FINDFIRST_S, overlapped->priority, attr, attr_mask, max_length, (void*)name_pattern);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->name_pattern   = (kal_wchar*)name_pattern;
    job->attr           = attr;
    job->attr_mask      = attr_mask;
    job->file_info      = file_info;
    job->file_name      = file_name;
    job->max_length     = max_length;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_FINDFIRST;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_FIND_FIRST_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_FINDFIRST_E, id, NULL);

    return id;
}

kal_int32 fs_async_find_first_n(const kal_wchar *name_pattern,
                                FS_Pattern_Struct * pattern_array, kal_uint32 pattern_num,
                                kal_uint8 array_mask, kal_uint8 attr, kal_uint8 attr_mask,
                                FS_DOSDirEntry *file_info, kal_wchar *file_name, kal_uint32 max_length,
                                kal_uint32 entry_index, kal_uint32 flag, fs_overlapped_struct *overlapped)
{
    kal_int32                   id;
    fs_job_find_first_n_struct  *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_FINDFIRSTN_S, overlapped->priority, max_length, entry_index, flag, (void*)name_pattern);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->name_pattern   = (kal_wchar*)name_pattern;
    job->pattern_array  = pattern_array;
    job->pattern_num    = pattern_num;
    job->array_mask     = array_mask;
    job->attr           = attr;
    job->attr_mask      = attr_mask;
    job->file_info      = file_info;
    job->file_name      = file_name;
    job->max_length     = max_length;
    job->entry_index    = entry_index;
    job->flag           = flag;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_FINDFIRSTN;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_FIND_FIRST_N_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_FINDFIRSTN_E, id, NULL);

    return id;
}

kal_int32 fs_async_get_folder_size(const kal_wchar* path, kal_int32 flag, void* recursive_stack, kal_uint32 stack_size, FS_ProgressCallback progress, fs_overlapped_struct *overlapped)
{
    kal_int32                       id;
    fs_job_get_folder_size_struct   *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_GETFOLDERSIZE_S, overlapped->priority, flag, (kal_uint32)recursive_stack, stack_size, (void*)path);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->path               = (kal_wchar*)path;
    job->flag               = flag;
    job->recursive_stack    = recursive_stack;
    job->stack_size         = stack_size;
    job->progress           = progress;

    // pack essential job information (specific to this API itself)
    job->api                = FS_API_GETFOLDERSIZE;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_GET_FOLDER_SIZE_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_GETFOLDERSIZE_E, id, NULL);

    return id;
}

void fs_async_msg_handler(local_para_struct *local_para)
{
    fs_job_struct   *job;
    FS_File         *f;

    job = ((fs_job_rsp_struct*)local_para)->job;

    /*
     * Check if user abort the job after job is finished.
     * If yes, for opening file case, close its file handle.
     */

    if (job->api == FS_API_OPEN ||
        job->api == FS_API_FINDFIRST ||
        job->api == FS_API_FINDFIRSTN)
    {
        if (job->result > FS_NO_ERROR)  // result should be valid file handle
        {
            f = fs_conf_get_file_by_fh(job->result);

            if (f != NULL)
            {
                f->Job = 0;     // clear connection of file handle and job ID to prevent being aborted incorrectly in the future.

                if (f->Valid == FS_FH_ABORTED)      // f->Valid may be set as FS_FH_ABORTED in fs_async_abort
                {
                    if (job->api == FS_API_OPEN)    // FS_OPEN
                    {
                        FS_Close(job->result);
                    }
                    else                            // FS_FindFirst(N)
                    {
                        FS_FindClose(job->result);
                    }

                    job->result = FS_ABORTED_ERROR;
                }
            }
        }
    }

    // call callback
    if (job->callback)
    {
        job->callback(job->id, job->result, (fs_async_callback_data_struct*)job);
    }

    /*
     * 1. Job ID: For unique integer mechanism, job ID is not required to be released.
     * 2. Job memory: Job memory address (job) is notified by callback and should be released by user itself.
     * 3. ILM memory: Ilm memory should be released by user task itself.
     */
}

kal_int32 fs_async_open(const kal_wchar *filename, kal_int32 flag, fs_overlapped_struct *overlapped)
{
    kal_uint32          lr;
    kal_int32           id;
    fs_job_open_struct  *job;

    FS_GET_RETURN_ADDRESS(lr);

    fs_util_trace_info2(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_OPEN_S, overlapped->priority, flag, (void*)filename);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->filename = (kal_wchar*)filename;
    job->flag     = flag;
    job->caller_address = lr;

    // pack essential job information (specific to this API itself)
    job->api      = FS_API_OPEN;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_OPEN_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_OPEN_E, id, NULL);

    return id;
}


// TODO:
kal_int32 fs_async_read(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *read, fs_overlapped_struct *overlapped)
{
    return fs_async_read_interleave(handle, data, length, read, 0, overlapped);
}

kal_int32 fs_async_read_interleave(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *read, kal_uint32 chunksize, fs_overlapped_struct *overlapped)
{
    kal_int32           id;
    fs_job_read_struct  *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_READ_S, overlapped->priority, handle, (kal_uint32)data, length, (void*)fs_conf_get_file_by_fh(handle));

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->handle     = handle;
    job->data       = data;
    job->length     = length;
    job->read       = read;
    job->chunksize  = chunksize;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_READ;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_READ_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_READ_E, id, NULL);

    return id;
}

kal_int32 fs_async_seek(FS_HANDLE handle, kal_int64 offset, kal_int32 whence, fs_overlapped_struct *overlapped)
{
    kal_int32           id;
    fs_job_seek_struct  *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_SEEK_S, overlapped->priority, (kal_uint32)handle, offset, whence, NULL);

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->handle     = handle;
    job->offset     = offset;
    job->whence     = whence;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_SEEK;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_SEEK_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_SEEK_E, id, NULL);

    return id;
}

kal_int32 fs_async_write(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *written, fs_overlapped_struct *overlapped)
{
    kal_int32               id;
    fs_job_write_struct     *job;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_WRITE_S, overlapped->priority, handle, (UINT)data, length, (void*)fs_conf_get_file_by_fh(handle));

    // initialize job
    if ((id = fs_async_int_initialize_job((fs_job_struct**)(&job), overlapped)) < 0)
    {
        return id;
    }

    // pack parameters (specific to this API itself)
    job->handle     = handle;
    job->data       = data;
    job->length     = length;
    job->written    = written;

    // pack essential job information (specific to this API itself)
    job->api        = FS_API_WRITE;

    // register this job to FS task
    fs_async_int_register_job((fs_job_struct*)job, MSG_ID_FS_WRITE_REQ);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_WRITE_E, id, NULL);

    return id;
}

#elif defined(__FS_ASYNC_SUPPORT_ALONE__)

#include "rtfiles.h"    // for _gfs_tls[]

static kal_int32 fs_async_int_initialize_job(void);

#define FS_ASYNC_ALONE_INTERNAL_API

static kal_int32 fs_async_int_initialize_job(void)
{
    fs_job_id       id;
    kal_int32       result;

    // request a Job ID (valid value is > 0)
    if ((result = fs_job_alloc_id(&id)) < 0)
    {
        return result;
    }

    result = (kal_int32)fs_conf_get_tls_idx();

    _gfs_tls[result].current_job = id;
    _gfs_tls[result].aborted     = KAL_FALSE;

    return (kal_int32)id;
}

void fs_async_int_response(fs_job_id id, fs_api_enum api, kal_int64 result, fs_overlapped_struct *overlapped)
{
    ilm_struct                      *ilm_ptr;
    fs_job_alone_rsp_struct         *rsp;
    fs_async_callback_data_struct   *data;
    module_type                     src_id;
    msg_type                        msg_id;
    kal_uint32                      tls_idx;

    tls_idx = fs_conf_get_tls_idx();

    _gfs_tls[tls_idx].current_job = 0;
    _gfs_tls[tls_idx].aborted     = KAL_FALSE;

    // Sending ILM when done, the user have to use fs_async_msg_handler() to execute the callback function.
    if (overlapped->response_flag != FS_RESPONSE_CALLBACK)
    {
        msg_id = fs_job_api_to_msgid(api);

        src_id = stack_get_active_module_id();

        // construct local parameter
        rsp = (fs_job_alone_rsp_struct*)construct_local_para(sizeof(fs_job_alone_rsp_struct), TD_RESET);

        // fill-in essential async related information
        data = rsp->data = (fs_async_callback_data_struct*)(overlapped->buf);
        data->api       = api;
        data->id        = id;
        data->result    = result;
        data->callback  = overlapped->callback;
        data->param     = overlapped->param;

        ilm_ptr = allocate_ilm(src_id);
        ilm_ptr->src_mod_id     = src_id;
        ilm_ptr->dest_mod_id    = src_id;   // send RSP message to itself
        ilm_ptr->sap_id         = FS_SAP;
        ilm_ptr->msg_id         = msg_id;
        ilm_ptr->local_para_ptr = (local_para_struct*)rsp;
        ilm_ptr->peer_buff_ptr  = NULL;

        msg_send_ext_queue(ilm_ptr);
    }
    // Calling Call Back Function directedly without sending ILM.
    else
    {
        data = (fs_async_callback_data_struct*)(overlapped->buf);

        data->api       = api;
        data->id        = id;
        data->result    = result;
        data->callback  = overlapped->callback;
        data->param     = overlapped->param;

        if (overlapped->callback)
        {
            overlapped->callback(id, result, data);
        }
    }
}

#define FS_ASYNC_ALONE_EXPORTED_API

/*
 * FS task is NOT supported
 *      1. Execute FS API directly by blocking way in requester's context.
 *      2. Send message with result and callback to requester itself.
 */
kal_int32 fs_async_abort_ex(fs_job_id job_id, void *buf)
{
    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_ABORT_S, job_id, NULL);

    if (job_id <= 0)    {
        return FS_ERR_INVALID_JOB_ID;
    }

    // check if target is running. If it is, set abort flag.
    fs_job_abort_ex(job_id, buf);

    return FS_NO_ERROR;
}

kal_int32 fs_async_abort(fs_job_id job_id)
{
    return fs_async_abort_ex(job_id, NULL);
}

kal_int32 fs_async_delete(const kal_wchar* filename, fs_overlapped_struct *overlapped)
{
    kal_int32   result;
    kal_int32   id;

    fs_util_trace_info1(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_DELETE_S, overlapped->priority, (void*)filename);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_Delete(filename);

    fs_async_int_response(id, FS_API_DELETE, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_DELETE_E, id, NULL);

    return id;
}

kal_int32 fs_async_find_first(const kal_wchar *name_pattern,
                              kal_uint8 attr, kal_uint8 attr_mask,
                              FS_DOSDirEntry *file_info, kal_wchar *file_name, kal_uint32 max_length,
                              fs_overlapped_struct *overlapped)
{
    kal_int32   result;
    kal_int32   id;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_FINDFIRST_S, overlapped->priority, attr, attr_mask, max_length, (void*)name_pattern);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_FindFirst(name_pattern, attr, attr_mask, file_info, file_name, max_length);

    fs_async_int_response(id, FS_API_FINDFIRST, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_FINDFIRST_E, id, NULL);

    return id;
}

kal_int32 fs_async_find_first_n(const kal_wchar *name_pattern,
                                FS_Pattern_Struct * pattern_array, kal_uint32 pattern_num,
                                kal_uint8 array_mask, kal_uint8 attr, kal_uint8 attr_mask,
                                FS_DOSDirEntry *file_info, kal_wchar *file_name, kal_uint32 max_length,
                                kal_uint32 entry_index, kal_uint32 flag, fs_overlapped_struct *overlapped)
{
    kal_int32   result;
    kal_int32   id;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_FINDFIRSTN_S, overlapped->priority, max_length, entry_index, flag, (void*)name_pattern);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_FindFirstN(name_pattern, pattern_array, pattern_num, array_mask, attr, attr_mask, file_info, file_name, max_length, entry_index, flag);

    fs_async_int_response(id, FS_API_FINDFIRSTN, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_FINDFIRSTN_E, id, NULL);

    return id;
}

kal_int32 fs_async_get_folder_size(const kal_wchar* path, kal_int32 flag, void* recursive_stack, kal_uint32 stack_size, FS_ProgressCallback progress, fs_overlapped_struct *overlapped)
{
    kal_int32   result;
    kal_int32   id;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_GETFOLDERSIZE_S, overlapped->priority, flag, (kal_uint32)recursive_stack, stack_size, (void*)path);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_GetFolderSizeEx(path, flag, recursive_stack, stack_size, progress);

    fs_async_int_response(id, FS_API_GETFOLDERSIZE, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_GETFOLDERSIZE_E, id, NULL);

    return id;
}

void fs_async_msg_handler(local_para_struct *local_para)
{
    fs_async_callback_data_struct   *data;
    FS_File                         *f;

    data = ((fs_job_alone_rsp_struct*)local_para)->data;

    /*
     * Check if user abort the job after job is finished.
     * If yes, for opening file case, close its file handle.
     */

    if (data->api == FS_API_OPEN ||
        data->api == FS_API_FINDFIRST ||
        data->api == FS_API_FINDFIRSTN)
    {
        if (data->result > FS_NO_ERROR)  // result should be valid file handle
        {
            f = fs_conf_get_file_by_fh(data->result);

            if (f != NULL)
            {
                f->Job = 0;     // clear connection of file handle and job ID to prevent being aborted incorrectly in the future.

                if (f->Valid == FS_FH_ABORTED)      // f->Valid may be set as FS_FH_ABORTED in fs_async_abort
                {
                    if (data->api == FS_API_OPEN)   // FS_OPEN
                    {
                        FS_Close(data->result);
                    }
                    else                            // FS_FindFirst(N)
                    {
                        FS_FindClose(data->result);
                    }

                    data->result = FS_ABORTED_ERROR;
                }
            }
        }
    }

    // do callback
    if (data->callback)
    {
        data->callback(data->id, data->result, data);
    }

    /*
     * 1. Job ID: For unique integer mechanism, job ID is not required to be released.
     * 2. Job memory: Job memory address (data) is notified by callback and should be released by user itself.
     * 3. ILM memory: Ilm memory should be released by user task itself.
     */
}

kal_int32 fs_async_open(const kal_wchar *filename, kal_int32 flag, fs_overlapped_struct *overlapped)
{
    kal_uint32  lr;
    kal_int32   result;
    kal_int32   id;

    FS_GET_RETURN_ADDRESS(lr);

    fs_util_trace_info2(TRACE_FUNC | MT_TRACE_INFO_WSTR, FS_API_FS_ASYNC_OPEN_S, overlapped->priority, flag, (void*)filename);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_OpenLR(filename, flag, lr);

    fs_async_int_response(id, FS_API_OPEN, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_OPEN_E, id, NULL);

    return id;
}

kal_int32 fs_async_read(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *read, fs_overlapped_struct *overlapped)
{
    return fs_async_read_interleave(handle, data, length, read, 0, overlapped);
}

kal_int32 fs_async_read_interleave(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *read, kal_uint32 chunksize, fs_overlapped_struct *overlapped)
{
    kal_int32   id;
    kal_int32   result=0;
    kal_uint32  segment_length, segment_read;
    kal_uint8  *ptr;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_READ_S, overlapped->priority, handle, (kal_uint32)data, length, (void*)fs_conf_get_file_by_fh(handle));

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    // The chunk is smaller than 32KB
    if (chunksize < (32)FS_KB) {
        result = FS_Read(handle ,data, length, read);
    }
    //
    else {
        ptr=data;
         if (read !=NULL)   {
             *read = 0;
         }
         while (length>0) {
             segment_length = (length > chunksize) ? chunksize : length;

             result = FS_Read(handle,
                              ptr,
                              segment_length,
                              &segment_read);

             if (result<0) break;

             if (read !=NULL)   {
                 *read += segment_read;
             }
             ptr       += segment_read;
             length    -= segment_read;
         }
     }

    fs_async_int_response(id, FS_API_READ, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_READ_E, id, NULL);

    return id;
}

kal_int32 fs_async_seek(FS_HANDLE handle, kal_int64 offset, kal_int32 whence, fs_overlapped_struct *overlapped)
{
    kal_int64   result;
    kal_int32   id;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_SEEK_S, overlapped->priority, (kal_uint32)handle, offset, whence, NULL);

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_SeekLargeFile(handle, offset, whence);

    fs_async_int_response(id, FS_API_SEEK, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_SEEK_E, id, NULL);

    return id;
}

kal_int32 fs_async_write(FS_HANDLE handle, void *data, kal_uint32 length, kal_uint32 *written, fs_overlapped_struct *overlapped)
{
    kal_int32   result;
    kal_int32   id;

    fs_util_trace_info4(TRACE_FUNC | MT_TRACE_INFO_FILE, FS_API_FS_ASYNC_WRITE_S, overlapped->priority, handle, (UINT)data, length, (void*)fs_conf_get_file_by_fh(handle));

    // initialize job (allocate JOB ID)
    if ((id = fs_async_int_initialize_job()) < 0)
    {
        return id;
    }

    result = FS_Write(handle ,data, length, written);

    fs_async_int_response(id, FS_API_WRITE, result, overlapped);

    fs_util_trace_info1(TRACE_FUNC, FS_API_FS_ASYNC_WRITE_E, id, NULL);

    return id;
}

#endif // __FS_ASYNC_SUPPORT_TASK__

#endif // !__SMART_PHONE_MODEM__