Merged macro.h into util.h.

flit · flit · commit 6f879203d531 · 2020-01-08T17:28:11.000-06:00
- Changed ELEMENTS_IN_ARRAY() to use ARRAY_SIZE().
- Using single definition of MAX().
diff --git a/source/daplink/circ_buf.c b/source/daplink/circ_buf.c
@@ -22,7 +22,6 @@
 #include "circ_buf.h"
 
 #include "cortex_m.h"
-#include "macro.h"
 #include "util.h"
 
 void circ_buf_init(circ_buf_t *circ_buf, uint8_t *buffer, uint32_t size)
diff --git a/source/daplink/daplink_debug.h b/source/daplink/daplink_debug.h
@@ -28,7 +28,7 @@
 #include <stdint.h>
 #include "cmsis_os2.h"
 #include "rl_usb.h"
-#include "macro.h"
+#include "util.h"
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/source/daplink/drag-n-drop/file_stream.c b/source/daplink/drag-n-drop/file_stream.c
@@ -23,7 +23,6 @@
 
 #include "file_stream.h"
 #include "util.h"
-#include "macro.h"
 #include "intelhex.h"
 #include "flash_decoder.h"
 #include "error.h"
@@ -80,7 +79,7 @@ stream_t stream[] = {
     {detect_bin, open_bin, write_bin, close_bin},   // STREAM_TYPE_BIN
     {detect_hex, open_hex, write_hex, close_hex},   // STREAM_TYPE_HEX
 };
-COMPILER_ASSERT(ELEMENTS_IN_ARRAY(stream) == STREAM_TYPE_COUNT);
+COMPILER_ASSERT(ARRAY_SIZE(stream) == STREAM_TYPE_COUNT);
 // STREAM_TYPE_NONE must not be included in count
 COMPILER_ASSERT(STREAM_TYPE_NONE > STREAM_TYPE_COUNT);
 
diff --git a/source/daplink/drag-n-drop/flash_decoder.c b/source/daplink/drag-n-drop/flash_decoder.c
@@ -23,7 +23,6 @@
 
 #include "flash_decoder.h"
 #include "util.h"
-#include "macro.h"
 #include "daplink.h"
 #include "flash_manager.h"
 #include "target_config.h"  // for target_device
diff --git a/source/daplink/drag-n-drop/flash_manager.c b/source/daplink/drag-n-drop/flash_manager.c
@@ -21,7 +21,6 @@
 
 #include "flash_manager.h"
 #include "util.h"
-#include "macro.h"
 #include "error.h"
 
 // Set to 1 to enable debugging
diff --git a/source/daplink/drag-n-drop/iap_flash_intf.c b/source/daplink/drag-n-drop/iap_flash_intf.c
@@ -29,7 +29,6 @@
 #include "compiler.h"
 #include "crc.h"
 #include "info.h"
-#include "macro.h"
 
 // Application start must be aligned to page write
 COMPILER_ASSERT(DAPLINK_ROM_APP_START % DAPLINK_MIN_WRITE_SIZE == 0);
diff --git a/source/daplink/drag-n-drop/vfs_user.c b/source/daplink/drag-n-drop/vfs_user.c
@@ -25,7 +25,6 @@
 
 #include "vfs_user.h"
 #include "vfs_manager.h"
-#include "macro.h"
 #include "error.h"
 #include "util.h"
 #include "settings.h"
diff --git a/source/daplink/drag-n-drop/virtual_fs.c b/source/daplink/drag-n-drop/virtual_fs.c
@@ -25,7 +25,6 @@
 #include "info.h"
 #include "settings.h"
 #include "compiler.h"
-#include "macro.h"
 #include "util.h"
 
 // Virtual file system driver
@@ -257,7 +256,7 @@ const virtual_media_t virtual_media_tmpl[] = {
     /* Raw filesystem contents follow */
 };
 // Keep virtual_media_idx_t in sync with virtual_media_tmpl
-COMPILER_ASSERT(MEDIA_IDX_COUNT == ELEMENTS_IN_ARRAY(virtual_media_tmpl));
+COMPILER_ASSERT(MEDIA_IDX_COUNT == ARRAY_SIZE(virtual_media_tmpl));
 
 static const FatDirectoryEntry_t root_dir_entry = {
     /*uint8_t[11] */ .filename = {""},
@@ -311,7 +310,7 @@ static void write_fat(file_allocation_table_t *fat, uint32_t idx, uint16_t val)
     high_idx = idx * 2 + 1;
 
     // Assert that this is still within the fat table
-    if (high_idx >= ELEMENTS_IN_ARRAY(fat->f)) {
+    if (high_idx >= ARRAY_SIZE(fat->f)) {
         util_assert(0);
         return;
     }
@@ -366,7 +365,7 @@ void vfs_init(const vfs_filename_t drive_name, uint32_t disk_size)
     virtual_media_idx = MEDIA_IDX_COUNT;
     data_start = 0;
 
-    for (i = 0; i < ELEMENTS_IN_ARRAY(virtual_media_tmpl); i++) {
+    for (i = 0; i < ARRAY_SIZE(virtual_media_tmpl); i++) {
         data_start += virtual_media[i].length;
     }
 
@@ -424,7 +423,7 @@ vfs_file_t vfs_create_file(const vfs_filename_t filename, vfs_read_cb_t read_cb,
     }
 
     // Update directory entry
-    if (dir_idx >= ELEMENTS_IN_ARRAY(dir_current.f)) {
+    if (dir_idx >= ARRAY_SIZE(dir_current.f)) {
         util_assert(0);
         return VFS_FILE_INVALID;
     }
@@ -438,7 +437,7 @@ vfs_file_t vfs_create_file(const vfs_filename_t filename, vfs_read_cb_t read_cb,
     de->first_cluster_low_16 = (first_cluster >> 0) & 0xFFFF;
 
     // Update virtual media
-    if (virtual_media_idx >= ELEMENTS_IN_ARRAY(virtual_media)) {
+    if (virtual_media_idx >= ARRAY_SIZE(virtual_media)) {
         util_assert(0);
         return VFS_FILE_INVALID;
     }
@@ -502,7 +501,7 @@ void vfs_read(uint32_t requested_sector, uint8_t *buf, uint32_t num_sectors)
     memset(buf, 0, num_sectors * VFS_SECTOR_SIZE);
     current_sector = 0;
 
-    for (i = 0; i < ELEMENTS_IN_ARRAY(virtual_media); i++) {
+    for (i = 0; i < ARRAY_SIZE(virtual_media); i++) {
         uint32_t vm_sectors = virtual_media[i].length / VFS_SECTOR_SIZE;
         uint32_t vm_start = current_sector;
         uint32_t vm_end = current_sector + vm_sectors;
diff --git a/source/daplink/error.c b/source/daplink/error.c
@@ -21,7 +21,6 @@
 
 #include "error.h"
 #include "util.h"
-#include "macro.h"
 #include "compiler.h"
 
 static const char *const error_message[] = {
@@ -223,7 +222,7 @@ static error_type_t error_type[] = {
     ERROR_TYPE_INTERFACE,
 };
 
-COMPILER_ASSERT(ERROR_COUNT == ELEMENTS_IN_ARRAY(error_message));
+COMPILER_ASSERT(ERROR_COUNT == ARRAY_SIZE(error_message));
 
 const char *error_get_string(error_t error)
 {
diff --git a/source/daplink/macro.h b/source/daplink/macro.h
diff --git a/source/daplink/util.h b/source/daplink/util.h
@@ -3,7 +3,7 @@
  * @brief   useful things
  *
  * DAPLink Interface Firmware
- * Copyright (c) 2009-2016, ARM Limited, All Rights Reserved
+ * Copyright (c) 2009-2020, ARM Limited, All Rights Reserved
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -25,8 +25,29 @@
 #include <stdbool.h>
 #include <stdint.h>
 
+// Protect commonly-defined macros with ifdefs, to prevent conflicts if redefined
+// in imported sources (mostly vendor SDKs).
+
+#if !defined(ARRAY_SIZE)
 //! @brief Get number of elements in the array.
 #define ARRAY_SIZE(array) (sizeof(array) / sizeof(array[0]))
+#endif
+
+#if !defined(MIN)
+#define MIN(a,b)                        ((a) < (b) ? (a) : (b))
+#endif
+
+#if !defined(MAX)
+#define MAX(a,b)                        ((a) > (b) ? (a) : (b))
+#endif
+
+#define MB(size)                        ((size) * 1024 * 1024)
+
+#define KB(size)                        ((size) * 1024)
+
+#define ROUND_UP(value, boundary)       ((value) + ((boundary) - (value)) % (boundary))
+
+#define ROUND_DOWN(value, boundary)     ((value) - ((value) % (boundary)))
 
 #ifdef __cplusplus
 extern "C" {
diff --git a/source/hic_hal/atmel/sam3u2c/uart.c b/source/hic_hal/atmel/sam3u2c/uart.c
@@ -35,9 +35,6 @@
 #define RX_OVRF_MSG_SIZE    (sizeof(RX_OVRF_MSG) - 1)
 
 
-#define MIN(a, b)     (((a) < (b)) ? (a) : (b))
-#define MAX(a, b)     (((a) > (b)) ? (a) : (b))
-
 #define I8   int8_t
 #define I16  int16_t
 #define I32  int32_t
diff --git a/source/hic_hal/freescale/iap/fsl_common.h b/source/hic_hal/freescale/iap/fsl_common.h
@@ -126,17 +126,17 @@ typedef int32_t status_t;
 
 /*! @name Min/max macros */
 /* @{ */
-#if !defined(MIN)
-#define MIN(a, b) ((a) < (b) ? (a) : (b))
-#endif
-
-#if !defined(MAX)
-#define MAX(a, b) ((a) > (b) ? (a) : (b))
-#endif
-/* @} */
-
-/*! @brief Computes the number of elements in an array. */
-#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+// #if !defined(MIN)
+// #define MIN(a, b) ((a) < (b) ? (a) : (b))
+// #endif
+//
+// #if !defined(MAX)
+// #define MAX(a, b) ((a) > (b) ? (a) : (b))
+// #endif
+// /* @} */
+//
+// /*! @brief Computes the number of elements in an array. */
+// #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
 
 /*! @name UINT16_MAX/UINT32_MAX value */
 /* @{ */
diff --git a/source/hic_hal/freescale/k20dx/usb_config.c b/source/hic_hal/freescale/k20dx/usb_config.c
@@ -19,6 +19,8 @@
  * limitations under the License.
  */
 
+#include "util.h"
+
 // <e> USB Device
 //   <i> Enable the USB Device functionality
 #define USBD_ENABLE                 1
@@ -393,7 +395,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE)
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT!=0)*(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/freescale/k26f/usb_config.c b/source/hic_hal/freescale/k26f/usb_config.c
@@ -19,6 +19,8 @@
  * limitations under the License.
  */
 
+#include "util.h"
+
 //*** <<< Use Configuration Wizard in Context Menu >>> ***
 
 // ****
@@ -403,7 +405,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE)
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT!=0)*(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/freescale/kl26z/usb_config.c b/source/hic_hal/freescale/kl26z/usb_config.c
@@ -19,6 +19,8 @@
  * limitations under the License.
  */
 
+#include "util.h"
+
 // <e> USB Device
 //   <i> Enable the USB Device functionality
 #define USBD_ENABLE                 1
@@ -394,7 +396,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE)
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT!=0)*(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/maxim/max32620/usb_config.c b/source/hic_hal/maxim/max32620/usb_config.c
@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+#include "util.h"
+
 /*------------------------------------------------------------------------------
  *      USB Device Configuration
  *----------------------------------------------------------------------------*/
@@ -393,7 +396,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE)
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT!=0)*(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/maxim/max32625/usb_config.c b/source/hic_hal/maxim/max32625/usb_config.c
@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+#include "util.h"
+
 /*------------------------------------------------------------------------------
  *      USB Device Configuration
  *----------------------------------------------------------------------------*/
@@ -393,7 +396,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE) 
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT!=0)*(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/nuvoton/m48ssidae/usb_config.c b/source/hic_hal/nuvoton/m48ssidae/usb_config.c
@@ -19,6 +19,8 @@
  * limitations under the License.
  */
 
+#include "util.h"
+
 // <e> USB Device
 //   <i> Enable the USB Device functionality
 #define USBD_ENABLE                 1
@@ -392,7 +394,7 @@
 
 #define USBD_IF_NUM_MAX             (USBD_BULK_ENABLE+USBD_WEBUSB_ENABLE+USBD_HID_ENABLE+USBD_MSC_ENABLE+(USBD_ADC_ENABLE*2)+(USBD_CDC_ACM_ENABLE*2)+USBD_CLS_ENABLE)
 #define USBD_MULTI_IF               (USBD_CDC_ACM_ENABLE*(USBD_HID_ENABLE|USBD_MSC_ENABLE|USBD_ADC_ENABLE|USBD_CLS_ENABLE|USBD_WEBUSB_ENABLE|USBD_BULK_ENABLE))
-#define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
+// #define MAX(x, y)                   (((x) < (y)) ? (y) : (x))
 #define USBD_EP_NUM_CALC0           MAX((USBD_HID_ENABLE    *(USBD_HID_EP_INTIN     )), (USBD_HID_ENABLE    *(USBD_HID_EP_INTOUT)))
 #define USBD_EP_NUM_CALC1           MAX((USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKIN    )), (USBD_MSC_ENABLE    *(USBD_MSC_EP_BULKOUT)))
 #define USBD_EP_NUM_CALC2           MAX((USBD_ADC_ENABLE    *(USBD_ADC_EP_ISOOUT    )), (USBD_CDC_ACM_ENABLE*(USBD_CDC_ACM_EP_INTIN)))
diff --git a/source/hic_hal/nxp/lpc11u35/flash.c b/source/hic_hal/nxp/lpc11u35/flash.c
@@ -22,7 +22,7 @@
 #include <string.h>
 #include "flash_hal.h"
 #include "iap.h"
-#include "macro.h"
+#include "util.h"
 #include "LPC11Uxx.h"
 
 // page buffer must be 4 byte algined and must reside in ram bank 1
diff --git a/source/hic_hal/nxp/lpc11u35/usb_config.c b/source/hic_hal/nxp/lpc11u35/usb_config.c
diff --git a/source/hic_hal/nxp/lpc4322/usb_config.c b/source/hic_hal/nxp/lpc4322/usb_config.c
diff --git a/source/hic_hal/stm32/stm32f103xb/usb_config.c b/source/hic_hal/stm32/stm32f103xb/usb_config.c
diff --git a/source/target/target_config.h b/source/target/target_config.h
diff --git a/source/usb/bulk/usbd_bulk.c b/source/usb/bulk/usbd_bulk.c
diff --git a/source/usb/msc/usbd_msc.c b/source/usb/msc/usbd_msc.c
