1 ; Various functions for the Interaction with the FAT16 Filesystem
3 ; Copyright (C) 2010 Frank Zoll
4 ; Copyright (C) 2010 Sprite_tm
5 ; Copyright (C) 2010 Leo C.
7 ; This file is part of avrcpm.
9 ; avrcpm is free software: you can redistribute it and/or modify it
10 ; under the terms of the GNU General Public License as published by
11 ; the Free Software Foundation, either version 3 of the License, or
12 ; (at your option) any later version.
14 ; avrcpm is distributed in the hope that it will be useful,
15 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ; GNU General Public License for more details.
19 ; You should have received a copy of the GNU General Public License
20 ; along with avrcpm. If not, see <http://www.gnu.org/licenses/>.
25 ; ============================================================================
28 ; Size of a Sector is fixed to 512 Bytes by Base - MMC Driver implementation
29 ; The Functions below therefore assume a fixed Size of 512 Bytes per Sector.
30 ; ============================================================================
35 ; ############################################################################
36 ; Defines for FAT16 Structures
37 ; ############################################################################
39 /*These are the Offsets to the Variables within the Bootsector of a FAT16
42 ;#define FAT16_BSO_SECSIZE 0x0b ; Offset to Sectorsize Word
43 #define FAT16_BSO_CLUSTSZ 0x0d ; Offset to Clustersize Byte
44 #define FAT16_BSO_RESSECT 0x0e ; Offset to Number of Reserved Sectors
45 #define FAT16_BSO_VOLPTR 0x1c ; Offset to First VolumeSector
46 #define FAT16_BSO_SECPERFAT 0x16 ; Offset to Number of Sectors per Fat
47 #define FAT16_BSO_NUMFATCP 0x10 ; Offset to Ammount of FAT Copys
48 #define FAT16_BSO_NUMDIRENT 0x11 ; Offset to Max. Root Dir. Entrys
49 #define FAT16_FIRST_IMAGENAME 'A' ; First letter of filename to search
50 #define FAT16_LAST_IMAGENAME 'Z' ; Last letter of filename to
52 #define FAT16_LAST_IMAGENAME 'A'+MAXDISKS-1 ; Last letter of filename to
56 ; ############################################################################
57 ; Start of Data Segment
58 ; ############################################################################
61 fat_partfound: .byte 1 ; (partition: 0= no found 0xff=found )
62 fat_parttbl: .byte 4 ; first fat16 partition entry
63 ; only startsector is needed
64 fat_clustersize: .byte 1 ; sectors per cluster
65 fat_numdirentrys:.byte 2 ; Max. num. of entrys within Rootdirektory
66 fat_ptr2fat: .byte 4 ; pointer to the first fat sector
67 fat_ptr2dat: .byte 4 ; pointer to the first data sector
69 /*These variables define a cache that holds the last Cluster and Sector
70 thats been searched vor. To save some of the valuabe SRAM- Space these
71 variables also are used as temporary variables by the function
74 fat_last_dsk: .byte 1 ; number of disk with entry in cache
75 fat_log_clust: .byte 2 ; last searched logical cluster
76 fat_clust_offset: .byte 1 ; offset within the cluster
77 fat_clust_ptr: .byte 4 ; sector of last real cluster
79 /* This Variable is only needed within the scanning of the directory
80 for tempoary variable storage.. todo: optimize away :-) */
81 fat_temp: .byte 3 ; for tempoary use
83 ; ############################################################################
84 ; Start of Code Segment
85 ; ############################################################################
88 ; ============================================================================
89 ; Function: Initialize internal FAT-Partition Variables
90 ; ============================================================================
92 ; ----------------------------------------------------------------------------
94 ; Variables : [out] fat_parttabl
95 ; ----------------------------------------------------------------------------
97 ; This Routine initializes the internal Variables, that point to the
98 ; first Found FAT16 Partition.
99 ; ============================================================================
100 fat_init_partitiontable:
111 ; ============================================================================
112 ; Function: Resets the Cache
113 ; ============================================================================
115 ; ----------------------------------------------------------------------------
117 ; Variables : [out] fat_log_clust
119 ; ----------------------------------------------------------------------------
121 ; This Routine resets the internal Cache- Variables. After reset, the
122 ; next read or write Command will initialize a scan of the FAT of
123 ; the FAT16-Partition for the given sector.
124 ; ============================================================================
126 sts fat_log_clust ,_255
127 sts fat_log_clust+1,_255
128 sts fat_last_dsk ,_255
131 ; ============================================================================
132 ; Function: Saves FAT16 Partitiondata for later Scanning
133 ; ============================================================================
135 ; ----------------------------------------------------------------------------
136 ; Registers : [in] z Pointer to the Partitondata
137 ; Variables : [out] fat_partfound Boolean for "Partition found"
138 ; [out] fat_parttbl Pointer to Partitiontable
139 ; ----------------------------------------------------------------------------
141 ; This funktion sets the internal Variables to the Start and Size
142 ; of a given FAT16 Paritition. This Information will be used for a
143 ; later scanning of the Partition. See Function "fat_scan_partition"
144 ; for more information.
145 ; ============================================================================
149 printstring "fat16 part found"
154 ; save variables on stack
158 ; set fat16 partition found flag
159 sts fat_partfound,_255
161 ; save data from first fat16 partition
164 ldd temp,z+PART_START
166 ldd temp,z+PART_START+1
168 ldd temp,z+PART_START+2
170 ldd temp,z+PART_START+3
173 ; reload variables from stack
179 ; ============================================================================
180 ; Read and Scann a FAT16 Partition for Imagedatefiles
181 ; ============================================================================
184 ; ----------------------------------------------------------------------------
185 ; This Routine reads the Bootblock and scanns it for a Diskimage
186 ; ============================================================================
192 printstring "fat16 scanning"
196 ; Check if a FAT16 Partition was realy found
203 printstring "free entrys in ptable ?"
207 ; Check for free Entrys in Partition table
213 printstring "read fat bootblock."
217 ; Scan partition start
224 ; Load first sector from Partition
227 breq fat_bootblock_check
229 ; Read error: Block not found
237 printstring "fat16 bootblock check"
241 ; get sectors per cluster from bootblock
242 ldiw z,hostbuf+FAT16_BSO_CLUSTSZ
244 sts fat_clustersize,temp
247 printstring "Sectors per Cluster "
252 ; get num of FAT Tables from bootblock
253 ldiw z,hostbuf+FAT16_BSO_NUMFATCP
255 sts fat_last_dsk,temp ; low byte
258 printstring "Ammount of FAT copies: "
263 ; get max num of entrys in root direktory from bootblock
264 ldiw z,hostbuf+FAT16_BSO_NUMDIRENT
266 sts fat_numdirentrys,temp ; low byte
268 sts fat_numdirentrys+1,temp2 ; high byte
271 printstring "Max. entrys in Rootdir.: "
276 ; Print begin of Volume
285 printstring "Begin of Volume at: "
295 ; get num of sectors per FAT-Table from bootblock
296 ldiw z,hostbuf+FAT16_BSO_SECPERFAT
298 sts fat_log_clust,temp ; low byte
300 sts fat_log_clust+1,temp2 ; high byte
303 printstring "Sectors per FAT__: "
308 ; get num of reseved sectors from bootblock
309 ldiw z,hostbuf+FAT16_BSO_RESSECT
313 ; Calculate begin of FAT within the Volume
331 printstring "Begin of FAT at___: "
341 ; Calculate begin of Root- Directory within the Volume
348 lds temp ,fat_log_clust
349 lds temp2,fat_log_clust+1
350 lds temp3,fat_last_dsk
354 breq fat_calc_dp_lend
363 rjmp fat_calc_dp_loop
366 sts fat_clust_ptr ,xl
367 sts fat_clust_ptr+1,xh
368 sts fat_clust_ptr+2,yl
369 sts fat_clust_ptr+3,yh
373 printstring "Begin of DIR at___: "
383 ; Calculate begin of DATA Clusters within the Volume
384 ; Num. Dir.Sektors = (Num. of Dir. Entrys * 32) / Bytes per Sektor
386 ; Sectorsize is fixed at 512 Bytes, makes 16 Entrys per Sektor
388 lds zl,fat_numdirentrys ; low byte
389 lds zh,fat_numdirentrys+1 ; high byte
391 ; Num. Direntrys / 16
402 lds xh,fat_clust_ptr+1
403 lds yl,fat_clust_ptr+2
404 lds yh,fat_clust_ptr+3
417 printstring "Begin of Data at__: "
427 ; Here Starts the Scann of the Directory for valid image Files.
429 ; Init Image-Namecounter
430 ldi temp,FAT16_FIRST_IMAGENAME
431 sts fat_last_dsk,temp
433 fat_scan_for_next_image:
435 ; Init Offset into Directory-Sectors
437 sts fat_clust_offset,temp
439 ; Init counter for number of entry left to scan
440 lds temp,fat_numdirentrys
441 sts fat_log_clust ,temp
443 lds temp,fat_numdirentrys+1
444 sts fat_log_clust+1,temp
446 fat_next_sector_loop:
447 ; Get a Pointer to the first Directory sector
449 lds xh,fat_clust_ptr+1
450 lds yl,fat_clust_ptr+2
451 lds yh,fat_clust_ptr+3
454 lds temp,fat_clust_offset
460 ; Load sector from Directory
463 breq fat_look_for_images
465 ; Read error: Block not found
469 ; Looks at a read directory block for image entrys
504 lds temp3,fat_last_dsk ; Get actual Diskname (A to Z)
524 rjmp fat_store_new_entry
536 cpi temp2,16 ; max entrys/sector
537 breq fat_scan_next_sector
538 rjmp fat_look_for_loop
540 fat_scan_next_sector:
543 lds _tmp0, fat_log_clust
544 lds _tmp1, fat_log_clust+1
549 sts fat_log_clust,_tmp0
550 sts fat_log_clust+1,_tmp1
556 lds temp,fat_clust_offset
558 sts fat_clust_offset,temp
560 rjmp fat_next_sector_loop
564 lds temp,fat_last_dsk
566 sts fat_last_dsk,temp
568 ldi temp2,FAT16_LAST_IMAGENAME
570 brge fat_scaned_last_disk
572 rjmp fat_scan_for_next_image
574 fat_scaned_last_disk:
579 ; Create new Partition Entry
582 ; Found a valid image
584 printstring "Found a valid Image! Z="
598 adiw y,PARTENTRY_SIZE
600 rjmp fat_look_store_loop
603 ; Set Type of Partition to FAT16- Fileimage
608 ; Offset to Startcluster + 2
619 ; Convert Filesize to ammount of sectors
620 ; (calc with 512byte/sector)
627 cpse _tmp0,_0 ;round up
639 ; store ammount of sectors in partitiontable
641 tst zl ;file size larger than 65535 sectors?
651 ; Test finding of the first sector
658 printstring "Begin of Image at: "
668 ; Check for another free entry in partition table
676 rjmp fat_scan_for_more
683 ; ============================================================================
684 ; Function: Cluster to HostSector
685 ; ============================================================================
686 ; Parameters: [in] xh,xl Cluster Number
687 ; [out] yh,yl,xh,xl Sector Number on Disk
688 ; ----------------------------------------------------------------------------
690 ; Variables : [used] fat_clustersize Ammount of Sectors per Cluster
692 ; ----------------------------------------------------------------------------
694 ; ! Only works with Clustersizes 2,4,8,16,32,64,128 !
695 ; ============================================================================
698 ; Get Offset into Data area of Disk
702 ; add begin of data area to offset
703 lds temp,fat_ptr2dat+0
705 lds temp,fat_ptr2dat+1
707 lds temp,fat_ptr2dat+2
709 lds temp,fat_ptr2dat+3
713 ; ============================================================================
714 ; Function: Cluster to Sector
715 ; ============================================================================
716 ; Registers: [in] xl,xh Cluster Number
717 ; [out] xl,xh,yl,yh Sector Number
718 ; Variables: [in] fat_clustersize Ammount of Sectors per Cluster
720 ; ----------------------------------------------------------------------------
722 ; Calculates the logical Sectornumber given the physical ClusterNumber
723 ; and the size of a Cluster un sectors.
725 ; ! Only works with Clustersizes 2,4,8,16,32,64,128 !
726 ; ============================================================================
730 sbiw x,2 ; Substract the 2 reserved clusters
732 lds temp,fat_clustersize
748 ; ====================================================================
749 ; Function: Searches a physical Cluster, given the logical Cluster
750 ; ====================================================================
751 ; Registers: [in] xh,xl logical- Cluster
752 ; [out] yh,yl physical- Cluster
754 ; --------------------------------------------------------------------
756 ; ====================================================================
759 rcall dsk_getpartentry ; get partition entry
761 ; Get First FAT- Cluster Number of Diskimage
766 .if FAT16_DBG_FAT > 0
767 printstring "Search log. Cluster "
773 printstring "Search phys. Cluster "
783 breq fat_found_phsy_clust
784 ; Get Next Cluster from Fat
786 ; Trick: 512 Bytes Per Sector equals to 256 FAT- Entrys per Sector
787 ; so given: yl is the Offset within the FAT Sector
788 ; yh is the number off se FAT sector to Read
790 ; in zh,zl: Pointer to Word within the Sector to read
791 ; in yh..xl: Start sector number (LBA)
792 ; out zh,zl : word thats been read
796 ; Create FAT Offset Value
807 ; Add Cluster offset within sector
820 ; Check next logical Cluster
824 rjmp fat_next_phsy_clust
826 ; Found the physical cluster
827 fat_found_phsy_clust:
829 .if FAT16_DBG_FAT > 0
830 printstring "Found phys. Cluster at:"
839 ; ============================================================================
840 ; Function: This Routine searches for the Sector within an Imagefile
841 ; ============================================================================
842 ; Registers: [out] xl,xh,yl,yh Pointer to the Sector on the SD-Card
843 ; [out] temp Error- Variable (0= No Error)
844 ; Variables: [in] hostdsk host disk #, (partition #)
845 ; [in] hostlba host block #, relative to part.start
846 ; [in] fat_last_dsk number of disk with entry in cache
847 ; [in] fat_log_clust last searched logical cluster
848 ; [in] fat_clust_offset offset within the cluster
849 ; [in] fat_clust_ptr sector of last real cluster
850 ; ----------------------------------------------------------------------------
852 ; This Routine uses the variables hostdsk and hostlba to find an Sector
854 ; The CP/M Sector given within "hostlba" are splited to a logical Cluster-
855 ; Number and the Subsector within this logical Cluster.
856 ; logical Cluster Number = hostlba / fat_clustersize
857 ; The logical Cluster Number will be compared to the logical Cluster- Number
858 ; within the Cache. When this Clusters are the same and the DiskID's are
859 ; also the same, then the cached physical Sector will be used.
860 ; When the Clusters or the Disks don't match, a seek for the physical
861 ; Cluster is performed. This seek is done thru an access over the FAT of
862 ; the FAT16 Partition. The Routine starts at the first Cluster of the
863 ; Imagefile and goes along the linked list of Clusternumber till it reaches
864 ; the searched cluster. The found Clusternumber will be used to calculate
865 ; the Sektor where this Cluster lies on the SD- Card. Both the found physical
866 ; Cluster and the logical Cluster together with the physical Sectornumber
867 ; are stored in the cache.
868 ; The last step done is to add the SubSectorOffset to the found physical
869 ; Sector. This gives the pointer to the Sector to be read and or written.
870 ; ============================================================================
874 rcall dsk_getpartentry ; get partition entry
881 ldd xl,z+5 ; get size of disk in sectors
884 cp temp,xl ; check given sector against disksize
892 ; ################# Get logical Number of Cluster within the imagefile
893 ; printstring "calc log sector"
894 ; Get logical Sectornumber from temp
899 ; Divide logical Sectornumber by size of Cluster in sectors
900 lds zl,fat_clustersize
913 rjmp fat_search_clst_lp
916 ; at this point xh and xl are carying the logical cluster number
917 ; printstring "find subsector"
918 ; ################# Get Subsector within the logical Cluster for later use
920 lds zl,fat_clustersize
924 breq fat_found_subsec
928 rjmp fat_search_clst_lp2
933 sts fat_clust_offset,zl
935 ; Check against last HOSTDISK searched
939 brne fat_wrong_cache_clst
941 ; Check against last Cluster searched
943 lds yh,fat_log_clust+1
946 brne fat_wrong_cache_clst
948 brne fat_wrong_cache_clst
950 ; Last Cluster = searched Cluster -> get Sectornumber from cache
952 lds xh,fat_clust_ptr+1
953 lds yl,fat_clust_ptr+2
954 lds yh,fat_clust_ptr+3
958 ; Cluster is not in cache, so we must search for it
959 fat_wrong_cache_clst:
963 sts fat_log_clust+1,xh
965 ; Map Logical Cluster-Number to "Physical" Cluster Number using the FAT
966 rcall fat_find_phsy_clust
968 ; Get StartSector of "physical" Cluster
972 ; Found the physical sector
973 .if FAT16_DBG_FAT > 0
974 printstring "Found phys. Sector at:"
982 ; Save the found Sector for later use into cache
983 sts fat_clust_ptr ,xl
984 sts fat_clust_ptr+1,xh
985 sts fat_clust_ptr+2,yl
986 sts fat_clust_ptr+3,yh
988 ; Add- Subsector to Startsector
990 lds zl,fat_clust_offset
996 ; Found the physical sector
997 .if FAT16_DBG_FAT > 0
998 printstring "Sector with Offset at:"
1010 ; ============================================================================
1011 ; Function: Does a Disk write operation
1012 ; ============================================================================
1013 ; Registers: [out] temp Error-Variable ( 0= No Error)
1014 ; Variables: [in] hostdsk host disk #, (partition #)
1015 ; [in] hostlba host block #, relative to part.start
1016 ; [in] hostbuf Sector to be written
1017 ; ----------------------------------------------------------------------------
1019 ; This Routine writes a Sector to the Imagefile inside an FAT16 Partition.
1020 ; ============================================================================
1023 .if FAT16_RWDEBUG > 1
1025 printstring "host write "
1034 rjmp fat_rdwr_err ; skip disk change detection code
1036 ; After a second thought, the following code doesn't make sense, because
1037 ; disk change (change of one or more disk images) can not reliably detected.
1038 ; At least with the existing code.
1042 rcall mgr_init_partitions
1048 lcall mmcWriteSect ; disabled till read is functioning
1061 ; ============================================================================
1062 ; Function: Does a Disk read operation
1063 ; ============================================================================
1065 ; Variables: [in] hostdsk host disk #, (partition #)
1066 ; [in] hostlba host block #, relative to part.start
1067 ; [out] hostbuf Sector read by this routine
1068 ; ----------------------------------------------------------------------------
1070 ; This Routine reads a Sector from the Imagefile inside an FAT16 Partition.
1071 ; ============================================================================
1074 .if FAT16_RWDEBUG > 1
1076 printstring "host read "
1083 .if FAT16_RWDEBUG > 0
1084 printstring "Read Image Sector:"
1103 rjmp fat_rdwr_err ; skip disk change detection code
1105 rcall mgr_init_partitions
1117 ; vim:set ts=8 noet nowrap