Loading...
Searching...
No Matches
raw.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2016 OTA keys S.A.
3 *
4 * This file is subject to the terms and conditions of the GNU Lesser General
5 * Public License v2.1. See the file LICENSE in the top level directory for more
6 * details.
7 */
8
9#pragma once
10
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30#include "sched.h"
31#include "can/can.h"
32#include "can/common.h"
33#include "can/device.h"
34
35#ifdef MODULE_CAN_MBOX
36#include "mbox.h"
37#endif
38
39#ifdef MODULE_TRX
40#include "can/can_trx.h"
41#endif
42
46#define RAW_CAN_DEV_UNDEF (-1)
47
62int raw_can_send(int ifnum, const can_frame_t *frame, kernel_pid_t pid);
63
77int raw_can_abort(int ifnum, int handle);
78
94int raw_can_subscribe_rx(int ifnum, struct can_filter *filter, kernel_pid_t pid, void *param);
95
107int raw_can_unsubscribe_rx(int ifnum, struct can_filter *filter, kernel_pid_t pid, void *param);
108
120
130int raw_can_get_can_opt(int ifnum, can_opt_t *opt);
131
141int raw_can_set_can_opt(int ifnum, can_opt_t *opt);
142
143#if defined(MODULE_CAN_MBOX) || defined(DOXYGEN)
158int raw_can_send_mbox(int ifnum, const can_frame_t *frame, mbox_t *mbox);
159
177int raw_can_subscribe_rx_mbox(int ifnum, struct can_filter *filter, mbox_t *mbox, void *param);
178
190int raw_can_unsubscribe_rx_mbox(int ifnum, struct can_filter *filter, mbox_t *mbox, void *param);
191#endif
192
201int raw_can_power_down(int ifnum);
202
211int raw_can_power_up(int ifnum);
212
220int raw_can_get_ifnum_by_name(const char *name);
221
229const char *raw_can_get_name_by_ifnum(int ifnum);
230
240
256int raw_can_set_bitrate(int ifnum, uint32_t bitrate, uint32_t sample_point);
257
258#if defined(MODULE_CAN_TRX) || defined(DOXYGEN)
270int raw_can_set_trx(int ifnum, can_trx_t *trx);
271#endif
272
273#ifdef __cplusplus
274}
275#endif
276
int raw_can_free_frame(can_rx_data_t *frame)
Free a received frame.
int raw_can_power_down(int ifnum)
Power down a given interface.
int raw_can_get_ifnum_by_name(const char *name)
Get the interface number of a given interface.
int raw_can_send_mbox(int ifnum, const can_frame_t *frame, mbox_t *mbox)
Send a CAN frame.
int raw_can_power_up(int ifnum)
Power up a given interface.
int raw_can_get_can_opt(int ifnum, can_opt_t *opt)
Get a CAN option opt from interface ifnum.
int raw_can_subscribe_rx(int ifnum, struct can_filter *filter, kernel_pid_t pid, void *param)
Subscribe to a CAN filter.
int raw_can_unsubscribe_rx_mbox(int ifnum, struct can_filter *filter, mbox_t *mbox, void *param)
Unsubscribe from reception for the given CAN filter and mbox.
int raw_can_send(int ifnum, const can_frame_t *frame, kernel_pid_t pid)
Send a CAN frame.
int raw_can_unsubscribe_rx(int ifnum, struct can_filter *filter, kernel_pid_t pid, void *param)
Unsubscribe from reception for the given CAN filter on pid thread.
int raw_can_set_can_opt(int ifnum, can_opt_t *opt)
Set a CAN option opt to interface ifnum.
int raw_can_abort(int ifnum, int handle)
Abort a CAN frame.
int raw_can_subscribe_rx_mbox(int ifnum, struct can_filter *filter, mbox_t *mbox, void *param)
Subscribe to a CAN filter.
const char * raw_can_get_name_by_ifnum(int ifnum)
Get the interface name of a given interface number.
int raw_can_set_trx(int ifnum, can_trx_t *trx)
Set a transceiver for a given interface.
int raw_can_set_bitrate(int ifnum, uint32_t bitrate, uint32_t sample_point)
Set the given bitrate/sample_point to the given ifnum.
candev_dev_t * raw_can_get_dev_by_ifnum(int ifnum)
Get the candev descriptor from a given interface number.
CAN generic transceiver interface.
int16_t kernel_pid_t
Unique process identifier.
Definition sched.h:138
struct can_trx can_trx_t
Generic transceiver descriptor.
struct can_rx_data can_rx_data_t
Received data structure.
struct can_frame can_frame_t
CAN frame.
Definition can.h:178
Mailbox API.
Scheduler API definition.
Controller Area Network filter.
Definition can.h:128
Structure to pass a CAN option.
Definition common.h:84
Mailbox struct definition.
Definition mbox.h:40
Definitions high-level CAN interface.
Definitions of high-level CAN interface.
Definitions of CAN device interface.
struct candev_dev candev_dev_t
candev descriptor to pass to the device thread