mirror of
https://github.com/micropython/micropython.git
synced 2026-05-01 13:20:14 +02:00
Angus Gratton
022570445b
API is different to the original machine.CAN proposal, as numerous shortcomings were found during initial implementation. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
42 lines
1.7 KiB
C
42 lines
1.7 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2024-2026 Angus Gratton
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#ifndef MICROPY_INCLUDED_EXTMOD_MACHINE_CAN_H
|
|
#define MICROPY_INCLUDED_EXTMOD_MACHINE_CAN_H
|
|
|
|
#include "py/obj.h"
|
|
|
|
// machine.CAN support APIs that are called from port-level C code
|
|
|
|
// Return the 0-based index of the CAN peripheral based on the name or the
|
|
// (1-based) number.
|
|
//
|
|
// Raises an exception if the identifier is invalid, doesn't exist, or is reserved.
|
|
mp_uint_t machine_can_get_index(mp_obj_t identifier);
|
|
|
|
void machine_can_deinit_all(void);
|
|
|
|
#endif // MICROPY_INCLUDED_EXTMOD_MACHINE_CAN_H
|