incubator-nuttx/include/nuttx/math32.h

242 lines
7.7 KiB
C

/****************************************************************************
* include/nuttx/math32.h
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
#ifndef __INCLUDE_NUTTX_MATH32_H
#define __INCLUDE_NUTTX_MATH32_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
/****************************************************************************
* Public Types
****************************************************************************/
/* These types are useful on platforms that do not support 64-bit types. */
struct int64_s
{
#ifdef CONFIG_ENDIAN_BIG
int32_t ms;
uint32_t ls;
#else
uint32_t ls;
int32_t ms;
#endif
};
struct uint64_s
{
#ifdef CONFIG_ENDIAN_BIG
uint32_t ms;
uint32_t ls;
#else
uint32_t ls;
uint32_t ms;
#endif
};
/****************************************************************************
* Public Data
****************************************************************************/
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: uneg64
*
* Description:
* Negate a 64-bit unsigned value.
*
* Input Parameters:
* value - The value to be negated.
*
****************************************************************************/
/* void uneg64(FAR const uint64_s *value); */
#define uneg64(value) \
do \
{ \
value->ms = ~value->ms; \
value->ls = -value->ls; \
if (value->ls == 0) \
{ \
value->ms++; \
} \
} \
while (0)
/****************************************************************************
* Name: uadd32x64
*
* Description:
* Add a 32-bit value to a 64-bit values and return the truncated 64-bit
* sum.
*
* Input Parameters:
* term1 and term2 - The values to be added
* sum - The location to return the product of the two values. sum may
* be one of term1 or term2
*
****************************************************************************/
void uadd32x64(uint32_t term1, FAR const struct uint64_s *term2,
FAR struct uint64_s *sum);
/****************************************************************************
* Name: uadd64
*
* Description:
* Add two 64-bit values and return a 64-bit sum.
*
* Input Parameters:
* term1 and term2 - The values to be added
* sum - The location to return the product of the two values. sum may
* be one of term1 or term2
*
****************************************************************************/
void uadd64(FAR const struct uint64_s *term1,
FAR const struct uint64_s *term2,
FAR struct uint64_s *sum);
/****************************************************************************
* Name: usub64x32
*
* Description:
* Subtract a 32-bit value from a 64-bit value and return the 64-bit
* difference.
*
* Input Parameters:
* minuend - The number from which another number (the Subtrahend) is
* to be subtracted.
* subtrahend - The number that is to be subtracted.
* difference - The location to return the difference of the two values.
* difference may the same as one of minuend or subtrahend.
*
****************************************************************************/
void usub64x32(FAR const struct uint64_s *minuend, uint32_t subtrahend,
FAR struct uint64_s *difference);
/****************************************************************************
* Name: usub64
*
* Description:
* Subtract two 64-bit values and return the 64-bit difference.
*
* Input Parameters:
* minuend - The number from which another number (the Subtrahend) is
* to be subtracted.
* subtrahend - The number that is to be subtracted.
* difference - The location to return the difference of the two values.
* difference may the same as one of minuend or subtrahend.
*
****************************************************************************/
void usub64(FAR const struct uint64_s *minuend,
FAR const struct uint64_s *subtrahend,
FAR struct uint64_s *difference);
/****************************************************************************
* Name: umul32
*
* Description:
* Multiply two 32-bit values, factor1 and factor2, and return the
* full 64-bit product.
*
* Input Parameters:
* factor1 and factor2 - The values to be multiplied
* product - The location to return the product of the two values.
*
****************************************************************************/
void umul32(uint32_t factor1, uint32_t factor2, FAR struct uint64_s *product);
/****************************************************************************
* Name: umul32x64
*
* Description:
* Multiply one 32-bit and one 64-bit values, factor1 and factor2,
* respectively, and return the truncated 64-bit product.
*
* Input Parameters:
* factor1 and factor2 - The values to be multiplied
* product - The location to return the product of the two values.
*
****************************************************************************/
void umul32x64(uint32_t factor1, FAR const struct uint64_s *factor2,
FAR struct uint64_s *product);
/****************************************************************************
* Name: umul64
*
* Description:
* Multiply two 64-bit values, factor1 and factor2, and return the
* truncated 64-bit product.
*
* Input Parameters:
* factor1 and factor2 - The values to be multiplied
* product - The location to return the product of the two values.
*
****************************************************************************/
void umul64(FAR const struct uint64_s *factor1,
FAR const struct uint64_s *factor2,
FAR struct uint64_s *product);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __INCLUDE_NUTTX_MATH32_H */