Merge pull request #30 from deepikabhavnani/sdh_repo_tidy

sd-driver repository clean-up to follow common mbed-os component organisation

LICENSE

@@ -0,0 +1,165 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.

TESTS/filesystem/basic/basic.cpp

@@ -435,15 +435,15 @@ static control_t fsfat_basic_test_04()
 #ifndef __ARMCC_VERSION
     int ret = -1;
     ret = fsfat_basic_fileno_check("stdin", stdin, STDIN_FILENO);
-    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stdin does not have expected file number (expected=%d, fileno=%d.\n", __func__, stdin, fileno(stdin));
+    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stdin does not have expected file number (expected=%d, fileno=%d.\n", __func__, (int) stdin, fileno(stdin));
     TEST_ASSERT_MESSAGE(ret == true, fsfat_basic_msg_g);
 
     ret = fsfat_basic_fileno_check("stdout", stdout, STDOUT_FILENO);
-    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stdout does not have expected file number (expected=%d, fileno=%d.\n", __func__, stdout, fileno(stdout));
+    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stdout does not have expected file number (expected=%d, fileno=%d.\n", __func__, (int) stdout, fileno(stdout));
     TEST_ASSERT_MESSAGE(ret == true, fsfat_basic_msg_g);
 
     ret = fsfat_basic_fileno_check("stderr", stderr, STDERR_FILENO);
-    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stderr does not have expected file number (expected=%d, fileno=%d.\n", __func__, stderr, fileno(stderr));
+    FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: stderr does not have expected file number (expected=%d, fileno=%d.\n", __func__, (int) stderr, fileno(stderr));
     TEST_ASSERT_MESSAGE(ret == true, fsfat_basic_msg_g);
 #endif  /* __ARMCC_VERSION */
     return CaseNext;
@@ -459,9 +459,7 @@ static control_t fsfat_basic_test_04()
 static control_t fsfat_basic_test_05()
 {
     FILE *f;
-    char *str = FSFAT_BASIC_TEST_05_TEST_STRING;
+    const char *str = FSFAT_BASIC_TEST_05_TEST_STRING;
-    char *buffer = (char *)malloc(sizeof(unsigned char) * strlen(FSFAT_BASIC_TEST_05_TEST_STRING));
-    int str_len = strlen(FSFAT_BASIC_TEST_05_TEST_STRING);
     int ret = 0;
 
     FSFAT_DBGLOG("%s:Write files\n", __func__);
@@ -475,7 +473,7 @@ static control_t fsfat_basic_test_05()
 
         ret = fprintf(f, str);
         FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: writing file.\n", __func__);
-        TEST_ASSERT_MESSAGE(ret == strlen(str), fsfat_basic_msg_g);
+        TEST_ASSERT_MESSAGE(ret == (int) strlen(str), fsfat_basic_msg_g);
 
         ret = fclose(f);
         FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: fclose() failed.\n", __func__);
@@ -510,8 +508,7 @@ static control_t fsfat_basic_test_06()
     FSFAT_DBGLOG("mac address: %02x,%02x,%02x,%02x,%02x,%02x\n", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
 
     FILE *f;
-    char *str = FSFAT_BASIC_TEST_05_TEST_STRING;
+    const char *str = FSFAT_BASIC_TEST_05_TEST_STRING;
-    char *buffer = (char *)malloc(sizeof(unsigned char) * strlen(FSFAT_BASIC_TEST_05_TEST_STRING));
     int str_len = strlen(FSFAT_BASIC_TEST_05_TEST_STRING);
 
     f = fopen(sd_file_path, "w");
@@ -520,7 +517,7 @@ static control_t fsfat_basic_test_06()
 
     ret = fprintf(f, str);
     FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: writing file.\n", __func__);
-    TEST_ASSERT_MESSAGE(ret == strlen(str), fsfat_basic_msg_g);
+    TEST_ASSERT_MESSAGE(ret == (int) strlen(str), fsfat_basic_msg_g);
 
     ret = fclose(f);
     FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: fclose() failed.\n", __func__);
@@ -615,9 +612,11 @@ static bool fsfat_basic_test_file_write_fhandle(const char *filename, const int
     }
     fsfat_basic_timer.stop();
     file.close();
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB write in %.3f sec with speed of %.4f KiB/s\n", byte_write, test_time_sec, speed);
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -639,9 +638,11 @@ static bool fsfat_basic_test_file_read_fhandle(const char *filename, const int k
     }
     fsfat_basic_timer.stop();
     file.close();
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB read in %.3f sec with speed of %.4f KiB/s\n", byte_read, test_time_sec, speed);
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -686,6 +687,7 @@ static control_t fsfat_basic_test_08()
         }
         break;
     }
+    TEST_ASSERT_MESSAGE(result == true, "something went wrong");
     return CaseNext;
 }
 
@@ -708,9 +710,11 @@ bool fsfat_basic_test_sf_file_write_stdio(const char *filename, const int kib_rw
     }
     fsfat_basic_timer.stop();
     fclose(file);
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB write in %.3f sec with speed of %.4f KiB/s\n", byte_write, test_time_sec, speed);
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -718,7 +722,6 @@ bool fsfat_basic_test_sf_file_write_stdio(const char *filename, const int kib_rw
 
 bool fsfat_basic_test_sf_file_read_stdio(const char *filename, const int kib_rw)
 {
-    bool result = true;
     FILE* file = fopen(filename, "r");
 
     FSFAT_BASIC_MSG(fsfat_basic_msg_g, FSFAT_BASIC_MSG_BUF_SIZE, "%s: Error: failed to open file.\n", __func__);
@@ -730,10 +733,11 @@ bool fsfat_basic_test_sf_file_read_stdio(const char *filename, const int kib_rw)
     }
     fsfat_basic_timer.stop();
     fclose(file);
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB read in %.3f sec with speed of %.4f KiB/s\n", byte_read, test_time_sec, speed);
-
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -772,6 +776,7 @@ static control_t fsfat_basic_test_09()
         }
         break;
     }
+    TEST_ASSERT_MESSAGE(result == true, "Expected true result not found");
     return CaseNext;
 }
 
@@ -795,9 +800,11 @@ bool fsfat_basic_test_file_write_fatfs(const char *filename, const int kib_rw)
     }
     fsfat_basic_timer.stop();
     f_close(&file);
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB write in %.3f sec with speed of %.4f KiB/s\n", byte_write, test_time_sec, speed);
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -819,9 +826,11 @@ bool fsfat_basic_test_file_read_fatfs(const char *filename, const int kib_rw)
     } while (res == FR_OK && bytes == sizeof(fsfat_basic_buffer));
     fsfat_basic_timer.stop();
     f_close(&file);
+#ifdef FSFAT_DEBUG
     double test_time_sec = fsfat_basic_timer.read_us() / 1000000.0;
     double speed = kib_rw / test_time_sec;
     FSFAT_DBGLOG("%d KiB read in %.3f sec with speed of %.4f KiB/s\n", byte_read, test_time_sec, speed);
+#endif
     fsfat_basic_timer.reset();
     return true;
 }
@@ -859,6 +868,7 @@ static control_t fsfat_basic_test_10()
         }
         break;
     }
+    TEST_ASSERT_MESSAGE(result == true, "Expected true result not found");
     return CaseNext;
 }
 

features/TESTS/examples/example1/example1.cpp

@@ -1,80 +0,0 @@
-#include "mbed.h"
-#include "FATFileSystem.h"
-#include "SDBlockDevice.h"
-#include <stdio.h>
-#include <errno.h>
-/* mbed_retarget.h is included after errno.h so symbols are mapped to
- * consistent values for all toolchains */
-#include "platform/mbed_retarget.h"
-
-
-SDBlockDevice sd(MBED_CONF_SD_SPI_MOSI, MBED_CONF_SD_SPI_MISO, MBED_CONF_SD_SPI_CLK, MBED_CONF_SD_SPI_CS);
-FATFileSystem fs("sd", &sd);
-
-void return_error(int ret_val){
-  if (ret_val)
-    printf("Failure. %d\n", ret_val);
-  else
-    printf("done.\n");
-}
-
-void errno_error(void* ret_val){
-  if (ret_val == NULL)
-    printf(" Failure. %d \n", errno);
-  else
-    printf(" done.\n");
-}
-
-int main()
-{
-	int error = 0;
-	printf("Welcome to the filesystem example.\n");
-
-	printf("Opening a new file, numbers.txt.");
-	FILE* fd = fopen("/sd/numbers.txt", "w+");
-	errno_error(fd);
-
-	for (int i = 0; i < 20; i++){
-		printf("Writing decimal numbers to a file (%d/20)\r", i);
-		fprintf(fd, "%d\n", i);
-	}
-	printf("Writing decimal numbers to a file (20/20) done.\n");
-
-	printf("Closing file.");
-	fclose(fd);
-	printf(" done.\n");
-
-	printf("Re-opening file read-only.");
-	fd = fopen("/sd/numbers.txt", "r");
-	errno_error(fd);
-
-	printf("Dumping file to screen.\n");
-	char buff[16] = {0};
-	while (!feof(fd)){
-		int size = fread(&buff[0], 1, 15, fd);
-		fwrite(&buff[0], 1, size, stdout);
-	}
-	printf("EOF.\n");
-
-	printf("Closing file.");
-	fclose(fd);
-	printf(" done.\n");
-
-	printf("Opening root directory.");
-	DIR* dir = opendir("/sd/");
-	errno_error(fd);
-
-	struct dirent* de;
-	printf("Printing all filenames:\n");
-	while((de = readdir(dir)) != NULL){
-		printf("  %s\n", &(de->d_name)[0]);
-	}
-
-	printf("Closeing root directory. ");
-	error = closedir(dir);
-	return_error(error);
-	printf("Filesystem Demo complete.\n");
-
-	while (true) {}
-}
-