foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
test_pwm.c File Reference

Tests for the PWM driver. More...

#include "unity.h"
#include "MockHL_etpwm.h"
#include "HL_ecap.h"
#include "pwm.h"
#include "test_assert_helper.h"
Include dependency graph for test_pwm.c:

Go to the source code of this file.

Functions

long FSYS_RaisePrivilege (void)
 Raise privilege. More...
 
void ecapInit (void)
 
uint32_t ecapGetCAP1 (ecapBASE_t *ecap)
 
uint32_t ecapGetCAP2 (ecapBASE_t *ecap)
 
uint32_t ecapGetCAP3 (ecapBASE_t *ecap)
 
void PWM_SetDutyCycle_Test (uint16_t timeBasePeriod, uint16_t dutyCycleIn, uint16_t dutyCycleOut)
 
uint16_t calculateCounterValue (uint16_t timeBasePeriod, uint16_t dutyCycle)
 
void setUp (void)
 
void tearDown (void)
 
void testPWM_StartPwm (void)
 
void testPWM_StopPwm (void)
 
void testPWM_SetDutyCycle (void)
 

Variables

static uint8_t fsysRaisePrivilegeReturnValue = 0u
 

Detailed Description

Tests for the PWM driver.

SPDX-License-Identifier: BSD-3-Clause

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 of the copyright holder 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 HOLDER 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.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2021-10-08 (date of creation)
Updated
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
TEST

Definition in file test_pwm.c.

Function Documentation

◆ calculateCounterValue()

uint16_t calculateCounterValue ( uint16_t  timeBasePeriod,
uint16_t  dutyCycle 
)

calculates the PWM counter value

Parameters
[in]timeBasePeriodThis time base period will be assumed for the calculation
[in]dutyCycleThe requested duty cycle in permill

Definition at line 112 of file test_pwm.c.

Here is the call graph for this function:

◆ ecapGetCAP1()

uint32_t ecapGetCAP1 ( ecapBASE_t *  ecap)

Definition at line 77 of file test_pwm.c.

◆ ecapGetCAP2()

uint32_t ecapGetCAP2 ( ecapBASE_t *  ecap)

Definition at line 80 of file test_pwm.c.

◆ ecapGetCAP3()

uint32_t ecapGetCAP3 ( ecapBASE_t *  ecap)

Definition at line 83 of file test_pwm.c.

◆ ecapInit()

void ecapInit ( void  )

Definition at line 75 of file test_pwm.c.

◆ FSYS_RaisePrivilege()

long FSYS_RaisePrivilege ( void  )

Raise privilege.

This alias is mapped to an ASM function and raises to a privileged processor state if the system is currently in user mode. This is done by the following ASM code:

  • Copy the contents of a CP14 or CP15 coprocessor register (in this case SPSR – Saved Program Status Register) into local register r12:
    mrs     r12, spsr 
  • Perform bitwise AND on the contents of r12 and 0x0F
  • write to r0
  • update condition code flag on result of operation
    ands    r0, r12, #0x0F      ; return value 
  • Perform a logical OR on the contents of r12 and 0x1F, if equal to condition code flag from previous instruction
  • write to r12
    orreq   r12, r12, #0x1F 
  • Conditionally (equal on previous instruction condition code flag) load immediate result from r12 into control field mask byte, PSR[7:0] (privileged software execution) from SPSR
    msreq   spsr_c, r12 
  • Branch and exchange instruction set
  • Target address is contained in r14
    bx      r14 

It is important to issue FSYS_SWITCH_TO_USER_MODE() after the privileged mode is no longer needed. Otherwise the system would stay in privileged mode.

The datatype of the return value has to be reevaluated when changing platform and compiler.

Returns
return value is zero if caller was in user mode (type: long)

Definition at line 71 of file test_pwm.c.

◆ PWM_SetDutyCycle_Test()

void PWM_SetDutyCycle_Test ( uint16_t  timeBasePeriod,
uint16_t  dutyCycleIn,
uint16_t  dutyCycleOut 
)

wraps the duty cycle function for test

The output duty cycle is tested against the value computed by the function.

Parameters
[in]timeBasePeriodThis value will be injected as a time base period
[in]dutyCycleInThis value will be passed as requested duty cycle in permill
[in]dutyCycleOutThe expected output duty cycle (in counts)

Definition at line 94 of file test_pwm.c.

Here is the call graph for this function:

◆ setUp()

void setUp ( void  )

Definition at line 135 of file test_pwm.c.

◆ tearDown()

void tearDown ( void  )

Definition at line 139 of file test_pwm.c.

◆ testPWM_SetDutyCycle()

void testPWM_SetDutyCycle ( void  )

tests the duty cycle function

Definition at line 169 of file test_pwm.c.

Here is the call graph for this function:

◆ testPWM_StartPwm()

void testPWM_StartPwm ( void  )

test that the start function calls etPWM API

Definition at line 145 of file test_pwm.c.

Here is the call graph for this function:

◆ testPWM_StopPwm()

void testPWM_StopPwm ( void  )

test that the stop function calls etPWM API

Definition at line 157 of file test_pwm.c.

Here is the call graph for this function:

Variable Documentation

◆ fsysRaisePrivilegeReturnValue

uint8_t fsysRaisePrivilegeReturnValue = 0u
static

Definition at line 70 of file test_pwm.c.