Bfx_16bits.h File Reference

This file contains the Bitfield functions for fixed point for 16 bit registers. More...

#include "Std_Types.h"

Go to the source code of this file.

Macros
#define	MAX_VALUE   32767
#define	MIN_VALUE   -32768
#define	MAX_VALUE_USIGNED   0xFFFF

Functions
static void	Bfx_SetBit_u16u8 (uint16 *Data, uint8 BitPn)
	Set a single bit in Data pointer
static void	Bfx_ClrBit_u16u8 (uint16 *Data, uint8 BitPn)
	Clears a single bit in Data pointer
static boolean	Bfx_GetBit_u16u8_u8 (uint16 Data, uint8 BitPn)
	Obtain one bit especified
static void	Bfx_SetBits_u16u8u8u8 (uint16 *Data, uint8 BitStartPn, uint8 BitLn, uint8 Status)
	Modifies consecutive bits acording to status
static uint8	Bfx_GetBits_u16u8u8_u16 (uint16 Data, uint8 BitStartPn, uint8 BitLn)
	Obtains consecutive bits from an unsigned integer
static void	Bfx_SetBitMask_u16u16 (uint16 *Data, uint16 Mask)
	Using a mask to set bits
static void	Bfx_ClrBitMask_u16u16 (uint16 *Data, uint16 Mask)
	Using a mask to clear bits
static boolean	Bfx_TstBitMask_u16u16_u8 (uint16 Data, uint16 Mask)
	Compare a mask with a seccion of an unsigned integer
static boolean	Bfx_TstBitLnMask_u16u16_u8 (uint16 Data, uint16 Mask)
	Compare any bit of a mask with a seccion of an unsigned integer
static boolean	Bfx_TstParityEven_u16_u8 (uint16 Data)
	Determines if an unsigned integer has even parity
static void	Bfx_ToggleBits_u16 (uint16 *Data)
	Changes the value of every bit of an unsigned integer
static void	Bfx_ToggleBitMask_u16u16 (uint16 *Data, uint16 Mask)
	Using a mask to toggle bits
static void	Bfx_ShiftBitRt_u16u8 (uint16 *Data, uint8 ShiftCnt)
	Shifts a unsigned integer to the right acourding to ShiftCnt
static void	Bfx_ShiftBitLt_u16u8 (uint16 *Data, uint8 ShiftCnt)
	Shifts a unsigned integer to the left acourding to ShiftCnt
static void	Bfx_RotBitRt_u16u8 (uint16 *Data, uint8 ShiftCnt)
	Rotates a unsigned integer to the right acourding to ShiftCnt
static void	Bfx_RotBitLt_u16u8 (uint16 *Data, uint8 ShiftCnt)
	Rotates a unsigned integer to the left acourding to ShiftCnt
static void	Bfx_CopyBit_u16u8u16u8 (uint16 *DestinationData, uint8 DestinationPosition, uint16 SourceData, uint8 SourcePosition)
	Copies a bit from an integer to another
static void	Bfx_PutBits_u16u8u8u16 (uint16 *Data, uint8 BitStartPn, uint8 BitLn, uint16 Pattern)
	Takes a pattern and puts it in an unsigned integer
static void	Bfx_PutBitsMask_u16u16u16 (uint16 *Data, uint16 Pattern, uint16 Mask)
	Takes a pattern and a mask and puts it in an unsigned integer
static void	Bfx_PutBit_u16u8u8 (uint16 *Data, uint8 BitPn, boolean Status)
	Sets the bit of an unsigned integer according to Status
static uint8	Bfx_CountLeadingOnes_u16 (uint16 Data)
	Counts consecutive ones
static uint8	Bfx_CountLeadingZeros_u16 (uint16 Data)
	Counts consecutive zeros
static uint8	Bfx_CountLeadingSigns_s16 (sint16 Data)
	Counts leading signs
static sint16	Bfx_ShiftBitSat_s16s8_s16 (sint8 ShiftCnt, sint16 Data)
	Arithmetic shift with saturation
static uint16	Bfx_ShiftBitSat_u16s8_u16 (sint8 ShiftCnt, uint16 Data)
	Arithmetic shift with saturation

Detailed Description

This file contains the Bitfield functions for fixed point for 16 bit registers.

Bfx routines specification specifies the functionality, API and the configuration of the AUTOSAR library for BIT functionality dedicated to fixed-point arithmetic routines. All bit functions are re-entrant and can handle several simultaneous requests from the application.

Function Documentation

Bfx_ClrBit_u16u8()

static void Bfx_ClrBit_u16u8 ( uint16 * Data, uint8 BitPn )

inlinestatic

Clears a single bit in Data pointer

This function shall clear the logical status of the input data to ’0’ at the requested bit position.

Parameters

Data	Unsigned integer to modify
BitPn	Number of bit to modify

Requirement

SWS_Bfx_00010, SWS_Bfx_00011, SWS_Bfx_00015

Bfx_ClrBitMask_u16u16()

static void Bfx_ClrBitMask_u16u16 ( uint16 * Data, uint16 Mask )

inlinestatic

Using a mask to clear bits

This function shall clear the logical status to ’0’ for the input data for all the bit positions as per the mask.

Parameters

Data	Unsigned integer to modify
Mask	Mask that indicates the bits to clear

Requirement

SWS_Bfx_00039, SWS_Bfx_00040, SWS_Bfx_00045

Bfx_CopyBit_u16u8u16u8()

static void Bfx_CopyBit_u16u8u16u8 ( uint16 * DestinationData, uint8 DestinationPosition, uint16 SourceData, uint8 SourcePosition )

inlinestatic

Copies a bit from an integer to another

This function shall copy a bit from source data from bit position to destination data at bit position.

Parameters

DestinationData	Unsigned integer receptor
DestinationPosition	Destination bit
SourceData	Unsigned integer source
SourcePosition	Source bit

Requirement

SWS_Bfx_00101, SWS_Bfx_00108

Bfx_CountLeadingOnes_u16()

static uint8 Bfx_CountLeadingOnes_u16 ( uint16 Data )

inlinestatic

Counts consecutive ones

Count the number of consecutive ones in Data starting with the most significant bit and return the result.

Parameters

Data	Unsigned integer to check

Return values

Counter

Requirement

SWS_Bfx_91003, SWS_Bfx_00137

Bfx_CountLeadingSigns_s16()

static uint8 Bfx_CountLeadingSigns_s16 ( sint16 Data )

inlinestatic

Counts leading signs

Count the number of consecutive bits which have the same value as most significant bit in Data, starting with bit at position msb minus one. Put the result in Data. It is the number of leading sign bits minus one, giving the number of redundant sign bits in Data.

Parameters

Data	Signed integer to count from

Return values

Counter

Requirement

SWS_Bfx_91004, SWS_Bfx_00139

Bfx_CountLeadingZeros_u16()

static uint8 Bfx_CountLeadingZeros_u16 ( uint16 Data )

inlinestatic

Counts consecutive zeros

Count the number of consecutive zeros in Data starting with the most significant bit and return the result.

Parameters

Data	Unsigned integer to check

Return values

Counter

Requirement

SWS_Bfx_91005, SWS_Bfx_00141

Bfx_GetBit_u16u8_u8()

static boolean Bfx_GetBit_u16u8_u8 ( uint16 Data, uint8 BitPn )

inlinestatic

Obtain one bit especified

This function shall return the logical status of the input data for the requested bit position.

Parameters

Data	Unsigned integer containing the bit
BitPn	Number of bit to obtain

Return values

Result

Requirement

SWS_Bfx_00016, SWS_Bfx_00017, SWS_Bfx_00020

Bfx_GetBits_u16u8u8_u16()

static uint8 Bfx_GetBits_u16u8u8_u16 ( uint16 Data, uint8 BitStartPn, uint8 BitLn )

inlinestatic

Obtains consecutive bits from an unsigned integer

This function shall return the Bits of the input data starting from ’BitStartPn’ for the length of ’BitLn’.

Parameters

Data	Unsigned integer with the bits
BitStartPn	Bit that indicates the start of the bits to obtain
BitLn	Number of bits to obtain

Return values

Result

Requirement

SWS_Bfx_00028, SWS_Bfx_00029, SWS_Bfx_00034

Bfx_PutBit_u16u8u8()

static void Bfx_PutBit_u16u8u8 ( uint16 * Data, uint8 BitPn, boolean Status )

inlinestatic

Sets the bit of an unsigned integer according to Status

This function shall update the bit specified by BitPn of input data as ’1’ or ’0’ as per ’Status’ value.

Parameters

Data	Unsigned integer to modify
BitPn	Pin to modify
Status	boolean value to set

Requirement

SWS_Bfx_00130, SWS_Bfx_00132

Bfx_PutBits_u16u8u8u16()

static void Bfx_PutBits_u16u8u8u16 ( uint16 * Data, uint8 BitStartPn, uint8 BitLn, uint16 Pattern )

inlinestatic

Takes a pattern and puts it in an unsigned integer

This function shall put bits as mentioned in Pattern to the input Data from the specified bit position.

Parameters

Data	Unsigned integer to modify
BitStartPn	LSB to start
BitLn	Lenght of the chain of bits
Pattern	Pattern to partially copy

Requirement

SWS_Bfx_00110, SWS_Bfx_00112

Bfx_PutBitsMask_u16u16u16()

static void Bfx_PutBitsMask_u16u16u16 ( uint16 * Data, uint16 Pattern, uint16 Mask )

inlinestatic

Takes a pattern and a mask and puts it in an unsigned integer

This function shall put all bits defined in Pattern and for which the corresponding Mask bit is set to 1 in the input Data.

Parameters

Data	Unsigned integer to modify
Pattern	Pattern to partially copy
Mask	Mask that indicates the bits to copy

Requirement

SWS_Bfx_00120, SWS_Bfx_00124

Bfx_RotBitLt_u16u8()

static void Bfx_RotBitLt_u16u8 ( uint16 * Data, uint8 ShiftCnt )

inlinestatic

Rotates a unsigned integer to the left acourding to ShiftCnt

This function shall rotate data to the right by ShiftCnt. The least significant bit is rotated to the most significant bit location for every single bit shift cycle.

Parameters

Data	Unsigned integer to modify
ShiftCnt	Number of shifts to perform

Requirement

SWS_Bfx_00095, SWS_Bfx_00098

Bfx_RotBitRt_u16u8()

static void Bfx_RotBitRt_u16u8 ( uint16 * Data, uint8 ShiftCnt )

inlinestatic

Rotates a unsigned integer to the right acourding to ShiftCnt

This function shall rotate data to the right by ShiftCnt. The least significant bit is rotated to the most significant bit location for every single bit shift cycle.

Parameters

Data	Unsigned integer to modify
ShiftCnt	Number of shifts to perform

Requirement

SWS_Bfx_00086, SWS_Bfx_00090

Bfx_SetBit_u16u8()

static void Bfx_SetBit_u16u8 ( uint16 * Data, uint8 BitPn )

inlinestatic

Set a single bit in Data pointer

This function shall set the logical status of input data as ’1’ at the requested bit position.

Parameters

Data	Unsigned integer to modify
BitPn	Number of bit to modify

Requirement

SWS_Bfx_00001, SWS_Bfx_00002, SWS_Bfx_00008

Bfx_SetBitMask_u16u16()

static void Bfx_SetBitMask_u16u16 ( uint16 * Data, uint16 Mask )

inlinestatic

Using a mask to set bits

This function shall set the data to logical status ’1’ as per the corresponding Mask bits when set to value 1 and remaining bits will retain their original values.

Parameters

Data	Unsigned integer to modify
Mask	Mask that indicates the bits to set

Requirement

SWS_Bfx_00035, SWS_Bfx_00036, SWS_Bfx_00038

Bfx_SetBits_u16u8u8u8()

static void Bfx_SetBits_u16u8u8u8 ( uint16 * Data, uint8 BitStartPn, uint8 BitLn, uint8 Status )

inlinestatic

Modifies consecutive bits acording to status

This function shall set the input data as ’1’ or ’0’ as per ’Status’ value starting from ’BitStartPn’ for the length ’BitLn’.

Parameters

Data	Unsigned integer to modify
BitStartPn	Bit that indicates the start of the bits to modify
BitLn	Number of bits to modify
Status	Value that the bits will take

Requirement

SWS_Bfx_00021, SWS_Bfx_00022, SWS_Bfx_00025

Bfx_ShiftBitLt_u16u8()

static void Bfx_ShiftBitLt_u16u8 ( uint16 * Data, uint8 ShiftCnt )

inlinestatic

Shifts a unsigned integer to the left acourding to ShiftCnt

This function shall shift data to the left by ShiftCnt. The least significant bit (right-most bit) is replaced by a ’0’ bit and the most significant bit (left-most bit) is discarded for every single bit shift cycle.

Parameters

Data	Unsigned integer to modify
ShiftCnt	Number of shifts to perform

Requirement

SWS_Bfx_00076, SWS_Bfx_00080

Bfx_ShiftBitRt_u16u8()

static void Bfx_ShiftBitRt_u16u8 ( uint16 * Data, uint8 ShiftCnt )

inlinestatic

Shifts a unsigned integer to the right acourding to ShiftCnt

This function shall shift data to the right by ShiftCnt. The most significant bit (left-most bit) is replaced by a ’0’ bit and the least significant bit (right-most bit) is discarded for every single bit shift cycle.

Parameters

Data	Unsigned integer to modify
ShiftCnt	Number of shifts to perform

Requirement

SWS_Bfx_00070, SWS_Bfx_00075

Bfx_ShiftBitSat_s16s8_s16()

static sint16 Bfx_ShiftBitSat_s16s8_s16 ( sint8 ShiftCnt, sint16 Data )

inlinestatic

Arithmetic shift with saturation

If the shift count is greater than or equal to zero, then shift the value in Data by the amount specified by shift count to left. For this function, arithmetic shift is performed. The vacated bits are filled with zeros and the result is saturated if its sign bit differs from the sign bits that are shifted out. If the shift count is less than zero, right-shift the value in Data by the absolute value of the shift count. The vacated bits are filled with the sign-bit (the most significant bit) and bits shifted out are discarded.

Parameters

ShiftCnt	Shift count
Data	Signed integer to check

Return values

Data

Requirement

SWS_Bfx_91002, SWS_Bfx_00134, SWS_Bfx_00135

< Maximun data value

< Minimun data value

Bfx_ShiftBitSat_u16s8_u16()

static uint16 Bfx_ShiftBitSat_u16s8_u16 ( sint8 ShiftCnt, uint16 Data )

inlinestatic

Arithmetic shift with saturation

If the shift count is greater than or equal to zero, then shift the value in Data by the amount specified by shift count to left. For this function a logical shift is performed. In this case the result is saturated, if the leading one bit is shifted out. If the shift count is less than zero, right-shift the value in Data by the absolute value of the shift count. The vacated bits are filled with the sign-bit (the most significant bit) and bits shifted out are discarded.

Parameters

ShiftCnt	Shift count
Data	Unsigned integer to check

Return values

Data

Requirement

SWS_Bfx_91002, SWS_Bfx_00134, SWS_Bfx_00135

< Maximum unsigned data value

Bfx_ToggleBitMask_u16u16()

static void Bfx_ToggleBitMask_u16u16 ( uint16 * Data, uint16 Mask )

inlinestatic

Using a mask to toggle bits

This function toggles the bits of data when the corresponding bit of the mask is enabled and set to 1.

Parameters

Data	Unsigned integer to modify
Mask	Mask that indicates the bits to toggle

Requirement

SWS_Bfx_00066, SWS_Bfx_00069

Bfx_ToggleBits_u16()

static void Bfx_ToggleBits_u16 ( uint16 * Data )

inlinestatic

Changes the value of every bit of an unsigned integer

This function toggles all the bits of data (1’s Complement Data).

Parameters

Data	Unsigned integer to modify

Requirement

SWS_Bfx_00061, SWS_Bfx_00065

Bfx_TstBitLnMask_u16u16_u8()

static boolean Bfx_TstBitLnMask_u16u16_u8 ( uint16 Data, uint16 Mask )

inlinestatic

Compare any bit of a mask with a seccion of an unsigned integer

This function makes a test on the input data and if at least one bit is set as per the mask, then the function shall return TRUE, otherwise it shall return FALSE.

Parameters

Data	Unsigned integer to compare
Mask	Mask used to compare

Return values

Result

Requirement

SWS_Bfx_00051, SWS_Bfx_00055

Bfx_TstBitMask_u16u16_u8()

static boolean Bfx_TstBitMask_u16u16_u8 ( uint16 Data, uint16 Mask )

inlinestatic

Compare a mask with a seccion of an unsigned integer

This function shall return TRUE, if all bits defined in Mask value are set in the input Data value. In all other cases this function shall return FALSE.

Parameters

Data	Unsigned integer to compare
Mask	Mask used to compare

Return values

Result

Requirement

SWS_Bfx_00046, SWS_Bfx_00047, SWS_Bfx_00050

Bfx_TstParityEven_u16_u8()

static boolean Bfx_TstParityEven_u16_u8 ( uint16 Data )

inlinestatic

Determines if an unsigned integer has even parity

This function tests the number of bits set to 1. If this number is even, it shall return TRUE, otherwise it returns FALSE.

Parameters

Data	Unsigned integer to compare

Return values

Result

Requirement

SWS_Bfx_00056, SWS_Bfx_00060