Skip to content

better code comment #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rusefillc wants to merge 1 commit into
base: master
Choose a base branch
from
Open

better code comment #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions inc/slcan.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
#ifndef _SLCAN_H
#define _SLCAN_H

/**
* @brief Parses CAN frame and generates SLCAN message
* @return Number of bytes in generated SLCAN message
*/
int8_t slcan_parse_frame(uint8_t *buf, CAN_RxHeaderTypeDef *frame_header, uint8_t* frame_data);

/**
* @brief Parses SLCAN message and configures CAN peripheral accordingly or transmits CAN frame
* @param buf: Pointer to SLCAN message
* @param len: Number of bytes in SLCAN message
* @return Zero if successful, other values indicate an error
*/
int8_t slcan_parse_str(uint8_t *buf, uint8_t len);

// maximum rx buffer len: extended CAN frame with timestamp
Expand Down