Statistics
| Branch: | Tag: | Revision:

amiro-lld / drivers / VL53L1X / v1 / api / platform / vl53l1_platform_user_defines.h @ 4dba9195

History | View | Annotate | Download (4.177 KB)

1
/*
2
* Copyright (c) 2017, STMicroelectronics - All Rights Reserved
3
*
4
* This file is part of VL53L1 Core and is dual licensed,
5
* either 'STMicroelectronics
6
* Proprietary license'
7
* or 'BSD 3-clause "New" or "Revised" License' , at your option.
8
*
9
********************************************************************************
10
*
11
* 'STMicroelectronics Proprietary license'
12
*
13
********************************************************************************
14
*
15
* License terms: STMicroelectronics Proprietary in accordance with licensing
16
* terms at www.st.com/sla0081
17
*
18
* STMicroelectronics confidential
19
* Reproduction and Communication of this document is strictly prohibited unless
20
* specifically authorized in writing by STMicroelectronics.
21
*
22
*
23
********************************************************************************
24
*
25
* Alternatively, VL53L1 Core may be distributed under the terms of
26
* 'BSD 3-clause "New" or "Revised" License', in which case the following
27
* provisions apply instead of the ones mentioned above :
28
*
29
********************************************************************************
30
*
31
* License terms: BSD 3-clause "New" or "Revised" License.
32
*
33
* Redistribution and use in source and binary forms, with or without
34
* modification, are permitted provided that the following conditions are met:
35
*
36
* 1. Redistributions of source code must retain the above copyright notice, this
37
* list of conditions and the following disclaimer.
38
*
39
* 2. Redistributions in binary form must reproduce the above copyright notice,
40
* this list of conditions and the following disclaimer in the documentation
41
* and/or other materials provided with the distribution.
42
*
43
* 3. Neither the name of the copyright holder nor the names of its contributors
44
* may be used to endorse or promote products derived from this software
45
* without specific prior written permission.
46
*
47
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
48
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
50
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
51
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
53
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
54
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
55
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
56
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57
*
58
*
59
********************************************************************************
60
*
61
*/
62

    
63

    
64
#ifndef _VL53L1_PLATFORM_USER_DEFINES_H_
65
#define _VL53L1_PLATFORM_USER_DEFINES_H_
66

    
67
#ifdef __cplusplus
68
extern "C"
69
{
70
#endif
71

    
72
/**
73
 * @file   vl53l1_platform_user_defines.h
74
 *
75
 * @brief  All end user OS/platform/application definitions
76
 */
77

    
78

    
79
/**
80
 * @def do_division_u
81
 * @brief customer supplied division operation - 64-bit unsigned
82
 *
83
 * @param dividend      unsigned 64-bit numerator
84
 * @param divisor       unsigned 64-bit denominator
85
 */
86
#define do_division_u(dividend, divisor) (dividend / divisor)
87

    
88

    
89
/**
90
 * @def do_division_s
91
 * @brief customer supplied division operation - 64-bit signed
92
 *
93
 * @param dividend      signed 64-bit numerator
94
 * @param divisor       signed 64-bit denominator
95
 */
96
#define do_division_s(dividend, divisor) (dividend / divisor)
97

    
98

    
99
/**
100
 * @def WARN_OVERRIDE_STATUS
101
 * @brief customer supplied macro to optionally output info when a specific
102
          error has been overridden with success within the EwokPlus driver
103
 *
104
 * @param __X__      the macro which enabled the suppression
105
 */
106
#define WARN_OVERRIDE_STATUS(__X__)\
107
        trace_print (VL53L1_TRACE_LEVEL_WARNING, #__X__);
108

    
109

    
110
#ifdef _MSC_VER
111
#define DISABLE_WARNINGS() { \
112
        __pragma (warning (push)); \
113
        __pragma (warning (disable:4127)); \
114
        }
115
#define ENABLE_WARNINGS() { \
116
        __pragma (warning (pop)); \
117
        }
118
#else
119
        #define DISABLE_WARNINGS()
120
        #define ENABLE_WARNINGS()
121
#endif
122

    
123

    
124
#ifdef __cplusplus
125
}
126
#endif
127

    
128
#endif // _VL53L1_PLATFORM_USER_DEFINES_H_