Rename to can-halal

This commit is contained in:
Jasper Blanckenburg 2023-03-18 20:20:00 +01:00
parent dc60f07b4a
commit eb74553f89
3 changed files with 8 additions and 8 deletions

View File

@ -1,4 +1,4 @@
# FaSTTUBe CAN Abstraction Layer # FaSTTUBe CAN HAL Abstraction Layer
This repository contains an abstraction layer to provide a simplified & unified This repository contains an abstraction layer to provide a simplified & unified
interface to the STM32 bxCAN and FDCAN peripherals. interface to the STM32 bxCAN and FDCAN peripherals.
@ -10,10 +10,10 @@ git submodule:
mkdir -p Core/Lib mkdir -p Core/Lib
cd Core/Lib cd Core/Lib
git submodule add ssh://git@git.fasttube.de:313/FaSTTUBe/FT_CAN_AL.git git submodule add ssh://git@git.fasttube.de:313/FaSTTUBe/can-halal.git
The library needs to be told what STM family you're using, so make sure one of The library needs to be told what STM family you're using, so make sure one of
the following symbols is defined when `FT_CAN_AL.c` is compiled or `FT_CAN_AL.h` the following symbols is defined when `can-halal.c` is compiled or `can-halal.h`
is included: is included:
- `STM32F3` - `STM32F3`
@ -25,7 +25,7 @@ in your `.ioc`).
## Usage ## Usage
1. Include `FT_CAN_AL.h` 1. Include `can-halal.h`
2. Call `ftcan_init()` with the appropriate handle 2. Call `ftcan_init()` with the appropriate handle
3. Call `ftcan_add_filter()` with all your filters 3. Call `ftcan_add_filter()` with all your filters
4. To transmit messages, call `ftcan_transmit()` 4. To transmit messages, call `ftcan_transmit()`

View File

@ -1,4 +1,4 @@
#include "FT_CAN_AL.h" #include "can-halal.h"
#include <string.h> #include <string.h>

View File

@ -1,5 +1,5 @@
#ifndef FT_CAN_AL_H #ifndef CAN_HALAL_H
#define FT_CAN_AL_H #define CAN_HALAL_H
#if defined(STM32F3) #if defined(STM32F3)
#include "stm32f3xx_hal.h" #include "stm32f3xx_hal.h"
@ -47,4 +47,4 @@ int64_t ftcan_unmarshal_signed(const uint8_t **data, size_t num_bytes);
uint8_t *ftcan_marshal_unsigned(uint8_t *data, uint64_t val, size_t num_bytes); uint8_t *ftcan_marshal_unsigned(uint8_t *data, uint64_t val, size_t num_bytes);
uint8_t *ftcan_marshal_signed(uint8_t *data, int64_t val, size_t num_bytes); uint8_t *ftcan_marshal_signed(uint8_t *data, int64_t val, size_t num_bytes);
#endif // FT_CAN_AL_H #endif // CAN_HALAL_H