divider.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Raspberry Pi (Trading) Ltd.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef _PICO_DIVIDER_H
#define _PICO_DIVIDER_H
 
#include "pico.h"
#include "hardware/divider.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
int32_t div_s32s32(int32_t a, int32_t b);
 
static inline int32_t divmod_s32s32_rem(int32_t a, int32_t b, int32_t *rem) {
    divmod_result_t r = hw_divider_divmod_s32(a, b);
    *rem = to_remainder_s32(r);
    return to_quotient_s32(r);
}
 
divmod_result_t divmod_s32s32(int32_t a, int32_t b);
 
uint32_t div_u32u32(uint32_t a, uint32_t b);
 
static inline uint32_t divmod_u32u32_rem(uint32_t a, uint32_t b, uint32_t *rem) {
    divmod_result_t r = hw_divider_divmod_u32(a, b);
    *rem = to_remainder_u32(r);
    return to_quotient_u32(r);
}
 
divmod_result_t divmod_u32u32(uint32_t a, uint32_t b);
 
int64_t div_s64s64(int64_t a, int64_t b);
 
int64_t divmod_s64s64_rem(int64_t a, int64_t b, int64_t *rem);
 
int64_t divmod_s64s64(int64_t a, int64_t b);
 
uint64_t div_u64u64(uint64_t a, uint64_t b);
 
uint64_t divmod_u64u64_rem(uint64_t a, uint64_t b, uint64_t *rem);
 
 
uint64_t divmod_u64u64(uint64_t a, uint64_t b);
 
// -----------------------------------------------------------------------
// these "unsafe" functions are slightly faster, but do not save the divider state,
// so are not generally safe to be called from interrupts
// -----------------------------------------------------------------------
 
int32_t div_s32s32_unsafe(int32_t a, int32_t b);
 
int32_t divmod_s32s32_rem_unsafe(int32_t a, int32_t b, int32_t *rem);
 
int64_t divmod_s32s32_unsafe(int32_t a, int32_t b);
 
uint32_t div_u32u32_unsafe(uint32_t a, uint32_t b);
 
uint32_t divmod_u32u32_rem_unsafe(uint32_t a, uint32_t b, uint32_t *rem);
 
uint64_t divmod_u32u32_unsafe(uint32_t a, uint32_t b);
 
int64_t div_s64s64_unsafe(int64_t a, int64_t b);
 
int64_t divmod_s64s64_rem_unsafe(int64_t a, int64_t b, int64_t *rem);
 
int64_t divmod_s64s64_unsafe(int64_t a, int64_t b);
 
uint64_t div_u64u64_unsafe(uint64_t a, uint64_t b);
 
uint64_t divmod_u64u64_rem_unsafe(uint64_t a, uint64_t b, uint64_t *rem);
 
uint64_t divmod_u64u64_unsafe(uint64_t a, uint64_t b);
 
#ifdef __cplusplus
}
#endif
#endif