diff --git a/docs/api/404.html b/docs/api/404.html index eaa6507..aef336d 100644 --- a/docs/api/404.html +++ b/docs/api/404.html @@ -163,6 +163,23 @@ +
  • + + + + + + Introduction + + +
    • + + + + + + +
  • @@ -231,6 +248,25 @@ +
  • + + + + + Introduction + + + + +
    • + + + + + + + +
  • diff --git a/docs/api/assembly/index.html b/docs/api/assembly/index.html index 489ab2e..536a77e 100644 --- a/docs/api/assembly/index.html +++ b/docs/api/assembly/index.html @@ -9,6 +9,8 @@ + + @@ -169,6 +171,23 @@ + +
  • + + + + + + Introduction + + +
    • + + + + + + @@ -239,6 +258,25 @@ + +
  • + + + + + Introduction + + + + +
    • + + + + + + + @@ -666,50 +704,52 @@

    ch376_check_exist

    Description

    Send a value, if ch376 is present, it will return $AA

    -

    Returns -$AA in accumulator if it's OK

    +

    ReturnsA +* Accumulator : $AA* if it's OK

    ch376_dir_create

    Description

    create a folder

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_disk_capacity

    Description

    check disk capacity

    ch376_disk_mount

    Description

    perform a disk mount

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_disk_query

    ch376_file_close

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_file_create

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_file_erase

    -

    Returns -ch376 status values

    ch376_file_open

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_get_descr

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_get_file_size

    ch376_ic_get_ver

    Description

    get version

    +

    ReturnsA +* Accumulator : ch376* firmware version

    ch376_lib_version

    Description

    Get lib version

    +

    ReturnsA +* Accumulator : ch376* lib version

    ch376_reset_all

    Description

    reset CH376

    ch376_seek_file

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    ch376_set_address

    ch376_set_config

    ch376_set_file_name

    @@ -719,8 +759,8 @@

    ch376_set_usb_mode

    Set usb mode

    ch376_set_usb_speed

    ch376_wait_response

    -

    Returns -ch376 status values

    +

    ReturnsA +* Accumulator : ch376* status values

    diff --git a/docs/api/c/index.html b/docs/api/c/index.html index 74d137e..0a33ead 100644 --- a/docs/api/c/index.html +++ b/docs/api/c/index.html @@ -170,6 +170,23 @@ +
  • + + + + + + Introduction + + +
    • + + + + + + +
  • @@ -240,6 +257,25 @@ +
  • + + + + + Introduction + + + + +
    • + + + + + + + +
  • @@ -699,9 +735,13 @@

    void ch376_get_file_size(void);

    unsigned char ch376_ic_get_version(void);

    Description

    get version

    +

    Returns +ch376 firmware version

    unsigned char ch376_lib_version(void);

    Description

    Get lib version

    +

    Returns +ch376 lib version

    void ch376_reset_all(void);

    Description

    reset CH376

    diff --git a/docs/api/index.html b/docs/api/index.html index 8811711..8be7844 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -10,6 +10,8 @@ + + @@ -66,11 +68,6 @@
    - - - Skip to content - -
    @@ -101,7 +98,7 @@
    - Home + Introduction
    @@ -167,6 +164,25 @@ + + + +
  • + + + + + + Introduction + + +
    • + + + + + +
  • @@ -235,6 +251,33 @@ + + + +
  • + + + + + + + + + + Introduction + + + + + +
    • + + + + + + +
  • @@ -287,375 +330,6 @@ - - -
    • @@ -669,67 +343,16 @@ -

    Home

    - -

    _ch376_check_exist

    -

    _ch376_dir_create

    -

    _ch376_disk_capacity

    -

    _ch376_disk_mount

    -

    _ch376_disk_query

    -

    _ch376_file_close

    -

    _ch376_file_create

    -

    _ch376_file_erase

    -

    _ch376_file_open

    -

    _ch376_get_descr

    -

    _ch376_get_file_size

    -

    _ch376_ic_get_ver

    -

    _ch376_lib_version

    -

    ch376_lib_version

    -

    _ch376_reset_all

    -

    _ch376_seek_file

    -

    _ch376_set_address

    -

    _ch376_set_config

    -

    _ch376_set_file_name

    -

    _ch376_set_usb_addr

    -

    _ch376_set_usb_mode

    -

    _ch376_set_usb_speed

    -

    _ch376_wait_response

    -

    _ch376_check_exist

    -

    _ch376_dir_create

    -

    _ch376_disk_capacity

    -

    _ch376_disk_mount

    -

    _ch376_disk_query

    -

    _ch376_file_close

    -

    _ch376_file_create

    -

    _ch376_file_erase

    -

    _ch376_file_open

    -

    _ch376_get_descr

    -

    _ch376_get_file_size

    -

    _ch376_ic_get_ver

    -

    _ch376_lib_version

    -

    Description

    -

    Get lib version

    -

    ch376_lib_version

    -

    Description

    -

    Get lib version

    -

    _ch376_reset_all

    -

    _ch376_seek_file

    -

    _ch376_set_address

    -

    _ch376_set_config

    -

    _ch376_set_file_name

    -

    _ch376_set_usb_addr

    -

    _ch376_set_usb_mode

    -

    Description

    -

    Set usb mode

    -

    _ch376_set_usb_speed

    -

    _ch376_wait_response

    +

    Introduction

    + +

    This lib (v2024.1) is used to manage ch376 chip for 6502 cpu

    Last update: - 2024-01-25 + 2024-01-26
    diff --git a/docs/api/search/search_index.json b/docs/api/search/search_index.json index 7331b50..b063b6b 100644 --- a/docs/api/search/search_index.json +++ b/docs/api/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#_ch376_check_exist","title":"_ch376_check_exist","text":""},{"location":"#_ch376_dir_create","title":"_ch376_dir_create","text":""},{"location":"#_ch376_disk_capacity","title":"_ch376_disk_capacity","text":""},{"location":"#_ch376_disk_mount","title":"_ch376_disk_mount","text":""},{"location":"#_ch376_disk_query","title":"_ch376_disk_query","text":""},{"location":"#_ch376_file_close","title":"_ch376_file_close","text":""},{"location":"#_ch376_file_create","title":"_ch376_file_create","text":""},{"location":"#_ch376_file_erase","title":"_ch376_file_erase","text":""},{"location":"#_ch376_file_open","title":"_ch376_file_open","text":""},{"location":"#_ch376_get_descr","title":"_ch376_get_descr","text":""},{"location":"#_ch376_get_file_size","title":"_ch376_get_file_size","text":""},{"location":"#_ch376_ic_get_ver","title":"_ch376_ic_get_ver","text":""},{"location":"#_ch376_lib_version","title":"_ch376_lib_version","text":""},{"location":"#ch376_lib_version","title":"ch376_lib_version","text":""},{"location":"#_ch376_reset_all","title":"_ch376_reset_all","text":""},{"location":"#_ch376_seek_file","title":"_ch376_seek_file","text":""},{"location":"#_ch376_set_address","title":"_ch376_set_address","text":""},{"location":"#_ch376_set_config","title":"_ch376_set_config","text":""},{"location":"#_ch376_set_file_name","title":"_ch376_set_file_name","text":""},{"location":"#_ch376_set_usb_addr","title":"_ch376_set_usb_addr","text":""},{"location":"#_ch376_set_usb_mode","title":"_ch376_set_usb_mode","text":""},{"location":"#_ch376_set_usb_speed","title":"_ch376_set_usb_speed","text":""},{"location":"#_ch376_wait_response","title":"_ch376_wait_response","text":""},{"location":"#_ch376_check_exist_1","title":"_ch376_check_exist","text":""},{"location":"#_ch376_dir_create_1","title":"_ch376_dir_create","text":""},{"location":"#_ch376_disk_capacity_1","title":"_ch376_disk_capacity","text":""},{"location":"#_ch376_disk_mount_1","title":"_ch376_disk_mount","text":""},{"location":"#_ch376_disk_query_1","title":"_ch376_disk_query","text":""},{"location":"#_ch376_file_close_1","title":"_ch376_file_close","text":""},{"location":"#_ch376_file_create_1","title":"_ch376_file_create","text":""},{"location":"#_ch376_file_erase_1","title":"_ch376_file_erase","text":""},{"location":"#_ch376_file_open_1","title":"_ch376_file_open","text":""},{"location":"#_ch376_get_descr_1","title":"_ch376_get_descr","text":""},{"location":"#_ch376_get_file_size_1","title":"_ch376_get_file_size","text":""},{"location":"#_ch376_ic_get_ver_1","title":"_ch376_ic_get_ver","text":""},{"location":"#_ch376_lib_version_1","title":"_ch376_lib_version","text":""},{"location":"#description","title":"Description","text":"

    Get lib version

    "},{"location":"#ch376_lib_version_1","title":"ch376_lib_version","text":""},{"location":"#description_1","title":"Description","text":"

    Get lib version

    "},{"location":"#_ch376_reset_all_1","title":"_ch376_reset_all","text":""},{"location":"#_ch376_seek_file_1","title":"_ch376_seek_file","text":""},{"location":"#_ch376_set_address_1","title":"_ch376_set_address","text":""},{"location":"#_ch376_set_config_1","title":"_ch376_set_config","text":""},{"location":"#_ch376_set_file_name_1","title":"_ch376_set_file_name","text":""},{"location":"#_ch376_set_usb_addr_1","title":"_ch376_set_usb_addr","text":""},{"location":"#_ch376_set_usb_mode_1","title":"_ch376_set_usb_mode","text":""},{"location":"#description_2","title":"Description","text":"

    Set usb mode

    "},{"location":"#_ch376_set_usb_speed_1","title":"_ch376_set_usb_speed","text":""},{"location":"#_ch376_wait_response_1","title":"_ch376_wait_response","text":""},{"location":"assembly/","title":"Assembly","text":""},{"location":"assembly/#assembly","title":"Assembly","text":""},{"location":"assembly/#ch376_check_exist","title":"ch376_check_exist","text":"

    Description

    Send a value, if ch376 is present, it will return $AA

    Returns $AA in accumulator if it's OK

    "},{"location":"assembly/#ch376_dir_create","title":"ch376_dir_create","text":"

    Description

    create a folder

    Returns ch376 status values

    "},{"location":"assembly/#ch376_disk_capacity","title":"ch376_disk_capacity","text":"

    Description

    check disk capacity

    "},{"location":"assembly/#ch376_disk_mount","title":"ch376_disk_mount","text":"

    Description

    perform a disk mount

    Returns ch376 status values

    "},{"location":"assembly/#ch376_disk_query","title":"ch376_disk_query","text":""},{"location":"assembly/#ch376_file_close","title":"ch376_file_close","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_file_create","title":"ch376_file_create","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_file_erase","title":"ch376_file_erase","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_file_open","title":"ch376_file_open","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_get_descr","title":"ch376_get_descr","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_get_file_size","title":"ch376_get_file_size","text":""},{"location":"assembly/#ch376_ic_get_ver","title":"ch376_ic_get_ver","text":"

    Description

    get version

    "},{"location":"assembly/#ch376_lib_version","title":"ch376_lib_version","text":"

    Description

    Get lib version

    "},{"location":"assembly/#ch376_reset_all","title":"ch376_reset_all","text":"

    Description

    reset CH376

    "},{"location":"assembly/#ch376_seek_file","title":"ch376_seek_file","text":"

    Returns ch376 status values

    "},{"location":"assembly/#ch376_set_address","title":"ch376_set_address","text":""},{"location":"assembly/#ch376_set_config","title":"ch376_set_config","text":""},{"location":"assembly/#ch376_set_file_name","title":"ch376_set_file_name","text":""},{"location":"assembly/#ch376_set_usb_addr","title":"ch376_set_usb_addr","text":""},{"location":"assembly/#ch376_set_usb_mode","title":"ch376_set_usb_mode","text":"

    Description

    Set usb mode

    "},{"location":"assembly/#ch376_set_usb_speed","title":"ch376_set_usb_speed","text":""},{"location":"assembly/#ch376_wait_response","title":"ch376_wait_response","text":"

    Returns ch376 status values

    "},{"location":"c/","title":"C","text":""},{"location":"c/#c","title":"C","text":""},{"location":"c/#unsigned-char-ch376_check_existvoid","title":"unsigned char ch376_check_exist(void);","text":"

    Description

    Send a value, if ch376 is present, it will return 0XAA

    Returns 0XAA if it's OK

    "},{"location":"c/#unsigned-char-ch376_dir_create","title":"unsigned char ch376_dir_create();","text":"

    Description

    create a folder

    "},{"location":"c/#ch376_disk_capacity","title":"ch376_disk_capacity();","text":"

    Description

    check disk capacity

    "},{"location":"c/#unsigned-char-ch376_disk_mountvoid","title":"unsigned char ch376_disk_mount(void);","text":"

    Description

    perform a disk mount

    Returns ch376 status values

    "},{"location":"c/#void-ch376_disk_queryvoid","title":"void ch376_disk_query(void);","text":""},{"location":"c/#unsigned-char-ch376_file_close","title":"unsigned char ch376_file_close();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_dir_create_1","title":"unsigned char ch376_dir_create();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_file_erase","title":"unsigned char ch376_file_erase();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_file_openvoid","title":"unsigned char ch376_file_open(void);","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_get_descrunsigned-char-mode","title":"unsigned char ch376_get_descr(unsigned char mode);","text":"

    Returns ch376 status values

    "},{"location":"c/#void-ch376_get_file_sizevoid","title":"void ch376_get_file_size(void);","text":""},{"location":"c/#unsigned-char-ch376_ic_get_versionvoid","title":"unsigned char ch376_ic_get_version(void);","text":"

    Description

    get version

    "},{"location":"c/#unsigned-char-ch376_lib_versionvoid","title":"unsigned char ch376_lib_version(void);","text":"

    Description

    Get lib version

    "},{"location":"c/#void-ch376_reset_allvoid","title":"void ch376_reset_all(void);","text":"

    Description

    reset CH376

    "},{"location":"c/#unsigned-int-ch376_seek_fileint-position","title":"unsigned int ch376_seek_file(int position);","text":"

    Returns ch376 status values

    "},{"location":"c/#void-ch376_set_addressunsigned-char-adress","title":"void ch376_set_address(unsigned char adress);","text":""},{"location":"c/#void-ch376_set_configunsigned-char-config","title":"void ch376_set_config(unsigned char config);","text":""},{"location":"c/#void-ch376_set_file_namechar-filename","title":"void ch376_set_file_name(char *filename);","text":""},{"location":"c/#void-ch376_set_usb_addrunsigned-char-adress","title":"void ch376_set_usb_addr(unsigned char adress);","text":"

    Description

    Set usb mode

    "},{"location":"c/#void-ch376_set_usb_modeunsigned-char-mode","title":"void ch376_set_usb_mode(unsigned char mode);","text":""},{"location":"c/#void-ch376_set_usb_speedunsigned-char-speed","title":"void ch376_set_usb_speed(unsigned char speed);","text":""},{"location":"c/#unsigned-char-ch376_wait_responsevoid","title":"unsigned char ch376_wait_response(void);","text":"

    Returns ch376 status values

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Introduction","text":"

    This lib (v2024.1) is used to manage ch376 chip for 6502 cpu

    "},{"location":"assembly/","title":"Assembly","text":""},{"location":"assembly/#assembly","title":"Assembly","text":""},{"location":"assembly/#ch376_check_exist","title":"ch376_check_exist","text":"

    Description

    Send a value, if ch376 is present, it will return $AA

    ReturnsA * Accumulator : $AA* if it's OK

    "},{"location":"assembly/#ch376_dir_create","title":"ch376_dir_create","text":"

    Description

    create a folder

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_disk_capacity","title":"ch376_disk_capacity","text":"

    Description

    check disk capacity

    "},{"location":"assembly/#ch376_disk_mount","title":"ch376_disk_mount","text":"

    Description

    perform a disk mount

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_disk_query","title":"ch376_disk_query","text":""},{"location":"assembly/#ch376_file_close","title":"ch376_file_close","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_file_create","title":"ch376_file_create","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_file_erase","title":"ch376_file_erase","text":""},{"location":"assembly/#ch376_file_open","title":"ch376_file_open","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_get_descr","title":"ch376_get_descr","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_get_file_size","title":"ch376_get_file_size","text":""},{"location":"assembly/#ch376_ic_get_ver","title":"ch376_ic_get_ver","text":"

    Description

    get version

    ReturnsA * Accumulator : ch376* firmware version

    "},{"location":"assembly/#ch376_lib_version","title":"ch376_lib_version","text":"

    Description

    Get lib version

    ReturnsA * Accumulator : ch376* lib version

    "},{"location":"assembly/#ch376_reset_all","title":"ch376_reset_all","text":"

    Description

    reset CH376

    "},{"location":"assembly/#ch376_seek_file","title":"ch376_seek_file","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"assembly/#ch376_set_address","title":"ch376_set_address","text":""},{"location":"assembly/#ch376_set_config","title":"ch376_set_config","text":""},{"location":"assembly/#ch376_set_file_name","title":"ch376_set_file_name","text":""},{"location":"assembly/#ch376_set_usb_addr","title":"ch376_set_usb_addr","text":""},{"location":"assembly/#ch376_set_usb_mode","title":"ch376_set_usb_mode","text":"

    Description

    Set usb mode

    "},{"location":"assembly/#ch376_set_usb_speed","title":"ch376_set_usb_speed","text":""},{"location":"assembly/#ch376_wait_response","title":"ch376_wait_response","text":"

    ReturnsA * Accumulator : ch376* status values

    "},{"location":"c/","title":"C","text":""},{"location":"c/#c","title":"C","text":""},{"location":"c/#unsigned-char-ch376_check_existvoid","title":"unsigned char ch376_check_exist(void);","text":"

    Description

    Send a value, if ch376 is present, it will return 0XAA

    Returns 0XAA if it's OK

    "},{"location":"c/#unsigned-char-ch376_dir_create","title":"unsigned char ch376_dir_create();","text":"

    Description

    create a folder

    "},{"location":"c/#ch376_disk_capacity","title":"ch376_disk_capacity();","text":"

    Description

    check disk capacity

    "},{"location":"c/#unsigned-char-ch376_disk_mountvoid","title":"unsigned char ch376_disk_mount(void);","text":"

    Description

    perform a disk mount

    Returns ch376 status values

    "},{"location":"c/#void-ch376_disk_queryvoid","title":"void ch376_disk_query(void);","text":""},{"location":"c/#unsigned-char-ch376_file_close","title":"unsigned char ch376_file_close();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_dir_create_1","title":"unsigned char ch376_dir_create();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_file_erase","title":"unsigned char ch376_file_erase();","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_file_openvoid","title":"unsigned char ch376_file_open(void);","text":"

    Returns ch376 status values

    "},{"location":"c/#unsigned-char-ch376_get_descrunsigned-char-mode","title":"unsigned char ch376_get_descr(unsigned char mode);","text":"

    Returns ch376 status values

    "},{"location":"c/#void-ch376_get_file_sizevoid","title":"void ch376_get_file_size(void);","text":""},{"location":"c/#unsigned-char-ch376_ic_get_versionvoid","title":"unsigned char ch376_ic_get_version(void);","text":"

    Description

    get version

    Returns ch376 firmware version

    "},{"location":"c/#unsigned-char-ch376_lib_versionvoid","title":"unsigned char ch376_lib_version(void);","text":"

    Description

    Get lib version

    Returns ch376 lib version

    "},{"location":"c/#void-ch376_reset_allvoid","title":"void ch376_reset_all(void);","text":"

    Description

    reset CH376

    "},{"location":"c/#unsigned-int-ch376_seek_fileint-position","title":"unsigned int ch376_seek_file(int position);","text":"

    Returns ch376 status values

    "},{"location":"c/#void-ch376_set_addressunsigned-char-adress","title":"void ch376_set_address(unsigned char adress);","text":""},{"location":"c/#void-ch376_set_configunsigned-char-config","title":"void ch376_set_config(unsigned char config);","text":""},{"location":"c/#void-ch376_set_file_namechar-filename","title":"void ch376_set_file_name(char *filename);","text":""},{"location":"c/#void-ch376_set_usb_addrunsigned-char-adress","title":"void ch376_set_usb_addr(unsigned char adress);","text":"

    Description

    Set usb mode

    "},{"location":"c/#void-ch376_set_usb_modeunsigned-char-mode","title":"void ch376_set_usb_mode(unsigned char mode);","text":""},{"location":"c/#void-ch376_set_usb_speedunsigned-char-speed","title":"void ch376_set_usb_speed(unsigned char speed);","text":""},{"location":"c/#unsigned-char-ch376_wait_responsevoid","title":"unsigned char ch376_wait_response(void);","text":"

    Returns ch376 status values

    "}]} \ No newline at end of file diff --git a/docs/api/sitemap.xml.gz b/docs/api/sitemap.xml.gz index b38c3d2..755b600 100644 Binary files a/docs/api/sitemap.xml.gz and b/docs/api/sitemap.xml.gz differ diff --git a/docs/ca65todoc.py b/docs/ca65todoc.py index 7a706e1..9ad27e0 100644 --- a/docs/ca65todoc.py +++ b/docs/ca65todoc.py @@ -108,8 +108,14 @@ elif inst[0] == ';;@param': line_out = '* '+ '*'+inst[1] +'* ' + ' '.join(inst[2:]) - elif inst[0] == ';;@returns': - line_out = '***Returns***\n'+ '*'+inst[1] +'* ' + ' '.join(inst[2:]) + elif inst[0] == ';;@returnsA': + line_out = '***ReturnsA***\n'+ '* Accumulator : '+inst[1] +'* ' + ' '.join(inst[2:]) + + elif inst[0] == ';;@returnsX': + line_out = '***ReturnsX***\n'+ '* X Register : '+inst[1] +'* ' + ' '.join(inst[2:]) + + elif inst[0] == ';;@returnsY': + line_out = '***ReturnsY***\n'+ '* Y Register : '+inst[1] +'* ' + ' '.join(inst[2:]) # Appel à une fonction elif inst[0].lower() == 'jsr': diff --git a/docs/code/assembly.md b/docs/code/assembly.md index 39a424e..9f4fda1 100644 --- a/docs/code/assembly.md +++ b/docs/code/assembly.md @@ -6,16 +6,16 @@ Send a value, if ch376 is present, it will return $AA -***Returns*** -*$AA* in accumulator if it's OK +***ReturnsA*** +* Accumulator : $AA* if it's OK ## ch376_dir_create ***Description*** create a folder -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_disk_capacity ***Description*** @@ -28,30 +28,28 @@ check disk capacity perform a disk mount -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_disk_query ## ch376_file_close -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_file_create -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_file_erase -***Returns*** -*ch376* status values ## ch376_file_open -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_get_descr -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_get_file_size ## ch376_ic_get_ver @@ -60,12 +58,16 @@ perform a disk mount get version +***ReturnsA*** +* Accumulator : ch376* firmware version ## ch376_lib_version ***Description*** Get lib version +***ReturnsA*** +* Accumulator : ch376* lib version ## ch376_reset_all ***Description*** @@ -74,8 +76,8 @@ reset CH376 ## ch376_seek_file -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values ## ch376_set_address ## ch376_set_config @@ -94,5 +96,5 @@ Set usb mode ## ch376_wait_response -***Returns*** -*ch376* status values +***ReturnsA*** +* Accumulator : ch376* status values diff --git a/docs/code/c.md b/docs/code/c.md index fb637d3..8a89409 100644 --- a/docs/code/c.md +++ b/docs/code/c.md @@ -58,12 +58,16 @@ perform a disk mount get version +***Returns*** +*ch376* firmware version ##unsigned char ch376_lib_version(void); ***Description*** Get lib version +***Returns*** +*ch376* lib version ##void ch376_reset_all(void); ***Description*** diff --git a/src/_ch376_check_exist.s b/src/_ch376_check_exist.s index 9e1127e..ef0ec8c 100644 --- a/src/_ch376_check_exist.s +++ b/src/_ch376_check_exist.s @@ -14,7 +14,7 @@ .proc ch376_check_exist ;;@brief Send a value, if ch376 is present, it will return $AA - ;;@returns $AA in accumulator if it's OK + ;;@returnsA $AA if it's OK lda #CH376_CHECK_EXIST ; sta CH376_COMMAND lda #$55 diff --git a/src/_ch376_dir_create.s b/src/_ch376_dir_create.s index fde29e4..0cd8be3 100644 --- a/src/_ch376_dir_create.s +++ b/src/_ch376_dir_create.s @@ -14,7 +14,7 @@ .proc ch376_dir_create ;;@brief create a folder - ;;@returns ch376 status values + ;;@returnsA ch376 status values lda #CH376_DIR_CREATE sta CH376_COMMAND jmp _ch376_wait_response diff --git a/src/_ch376_disk_mount.s b/src/_ch376_disk_mount.s index 0f521f9..54d8e79 100644 --- a/src/_ch376_disk_mount.s +++ b/src/_ch376_disk_mount.s @@ -13,7 +13,7 @@ .proc ch376_disk_mount ;;@brief perform a disk mount - ;;@returns ch376 status values + ;;@returnsA ch376 status values lda #CH376_DISK_MOUNT sta CH376_COMMAND jmp _ch376_wait_response diff --git a/src/_ch376_disk_query.s b/src/_ch376_disk_query.s index 4401d63..8d519ea 100644 --- a/src/_ch376_disk_query.s +++ b/src/_ch376_disk_query.s @@ -9,9 +9,11 @@ .proc _ch376_disk_query ;;@proto void ch376_disk_query(void); + ;;@bug Impossible to use .endproc .proc ch376_disk_query + ;;@bug Impossible to use lda #CH376_DISK_QUERY sta CH376_COMMAND jsr _ch376_wait_response diff --git a/src/_ch376_file_close.s b/src/_ch376_file_close.s index 8e9d4dc..46b94c7 100644 --- a/src/_ch376_file_close.s +++ b/src/_ch376_file_close.s @@ -14,7 +14,7 @@ ; A contains 0 if it needs to update length .proc ch376_file_close - ;;@returns ch376 status values + ;;@returnsA ch376 status values ldx #CH376_FILE_CLOSE stx CH376_COMMAND .IFPC02 diff --git a/src/_ch376_file_create.s b/src/_ch376_file_create.s index 7e0a76c..b313527 100644 --- a/src/_ch376_file_create.s +++ b/src/_ch376_file_create.s @@ -12,7 +12,7 @@ .endproc .proc ch376_file_create - ;;@returns ch376 status values + ;;@returnsA ch376 status values lda #CH376_CMD_FILE_CREATE sta CH376_COMMAND jmp _ch376_wait_response diff --git a/src/_ch376_file_open.s b/src/_ch376_file_open.s index fd32d39..9a2d39d 100644 --- a/src/_ch376_file_open.s +++ b/src/_ch376_file_open.s @@ -12,7 +12,7 @@ .endproc .proc ch376_file_open - ;;@returns ch376 status values + ;;@returnsA ch376 status values lda #CH376_FILE_OPEN sta CH376_COMMAND jmp _ch376_wait_response diff --git a/src/_ch376_get_descr.s b/src/_ch376_get_descr.s index d815bba..a00d010 100644 --- a/src/_ch376_get_descr.s +++ b/src/_ch376_get_descr.s @@ -13,7 +13,7 @@ .proc ch376_get_descr ; Get A : type descriptor or config - ;;@returns ch376 status values + ;;@returnsA ch376 status values ldx #CH376_CMD_GET_DESCR stx CH376_COMMAND sta CH376_DATA diff --git a/src/_ch376_get_file_size.s b/src/_ch376_get_file_size.s index a3bfea8..5d774f1 100644 --- a/src/_ch376_get_file_size.s +++ b/src/_ch376_get_file_size.s @@ -9,9 +9,11 @@ .proc _ch376_get_file_size ;;@proto void ch376_get_file_size(void); + ;;@bug Impossible to use .endproc .proc ch376_get_file_size + ;;@bug Impossible to use lda #CH376_GET_FILE_SIZE sta CH376_COMMAND lda #$68 diff --git a/src/_ch376_ic_get_ver.s b/src/_ch376_ic_get_ver.s index 38f715e..73a7066 100644 --- a/src/_ch376_ic_get_ver.s +++ b/src/_ch376_ic_get_ver.s @@ -7,6 +7,7 @@ .proc _ch376_ic_get_ver ;;@proto unsigned char ch376_ic_get_version(void); ;;@brief get version + ;;@returns ch376 firmware version ;;Follow next routine .endproc @@ -16,5 +17,6 @@ sta CH376_COMMAND lda CH376_DATA and #%00111111 ; A contains revision + ;;@returnsA ch376 firmware version rts .endproc diff --git a/src/_ch376_lib_version.s b/src/_ch376_lib_version.s index b6dc6d9..482c749 100644 --- a/src/_ch376_lib_version.s +++ b/src/_ch376_lib_version.s @@ -7,6 +7,7 @@ .proc _ch376_lib_version ;;@proto unsigned char ch376_lib_version(void); ;;@brief Get lib version + ;;@returns ch376 lib version ldx #$00 .endproc @@ -15,5 +16,6 @@ .proc ch376_lib_version ;;@brief Get lib version lda #CH376_LIB_VERSION_2024_1 + ;;@returnsA ch376 lib version rts .endproc diff --git a/src/_ch376_seek_file.s b/src/_ch376_seek_file.s index e6d70c2..4a7ca2c 100644 --- a/src/_ch376_seek_file.s +++ b/src/_ch376_seek_file.s @@ -15,7 +15,7 @@ ; [IN] AY : ptr .proc ch376_seek_file - ;;@returns ch376 status values + ;;@returnsA ch376 status values ldx #CH376_BYTE_LOCATE stx CH376_COMMAND sta CH376_DATA diff --git a/src/_ch376_wait_response.s b/src/_ch376_wait_response.s index bbf1c5c..8c706f0 100644 --- a/src/_ch376_wait_response.s +++ b/src/_ch376_wait_response.s @@ -11,7 +11,7 @@ .endproc .proc ch376_wait_response - ;;@returns ch376 status values + ;;@returnsA ch376 status values ; 1 return 1 if usb controller does not respond ; else A contains answer of the controller ldy #$FF