mirror of
https://github.com/elua/elua.git
synced 2025-01-08 20:56:17 +08:00
17487f9ebe
- This should actually be a merge but we made a mistake on the initial repo creation and a merge was not possible. - Below there is a resumed log of the commit messages for the few steps, just for the record. - The merged commit messages for this work are: - Removing Portuguese doc content - Ignore folder names fixed on .gitignore - Removed doc files which content migrated to the CMS - docdata.lua updated accordingly - Doc build checked ok - Overall doc structure and contents still being refined - Removing folder cache from git versioning - Removing folder dist from git versioning. The folders above are generated by the buildall.lua script and are not part of the sources - Adding .gitignore file with objects info to inform git what to ignore - Removed file - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - Moving all files and folders to a working doc folder - Css updated - Index page added and CSS adjusts - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com> - Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git - files deleted - Changed function that creates functions submenus. - Menu inserted with árvore, CSS adjusts, google search - Changed past design to new design - CSS updated - initial import - The commit ids were also preserved but they are related to this "other" work done on Led Lab. We'll keep the repo just in case. 4dce3f77c47b0c3001a2075a946e80ee52759b49 - Removing Portuguese doc content 78d8847525cacf045fe7e672cff6bd1e058a6a4b Ignore folder names fixed on .gitignore 48dee6b7962168ab1098bf709ead6f3cfe6b7964 - Removed doc files which content migrated to the CMS - docdata.lua updated accordingly - Doc build checked ok - Overall doc structure and contents still being refined 2aa2fe0c554db03dbc7029c34d0f4500fe625b37 - Removing folder cache from git versioning - Removing folder dist from git versioning The folders above are generated by the buildall.lua script and are not part of the sources - Adding .gitignore file with objects info to inform git what to ignore af6cc2890edf1855af319dc999a03feee5f9bee0 Removed file 6a180e72eb4f4860620cafc0685000e9f2174cfe Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git eb430112e78ae537459ab315e228ebca84bdf2d4 Moving all files and folders to a working doc folder d28a7c99489915630bd2625f3756fecf0d08ce37 Css updated 32836ffe382f04ab07c3e6f018c7b449a20d7a8d Index page added and CSS adjusts 1461d9957d9d25a1467cb57ab8717aa213a37e8d Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git ae1934c04f35a29e25bb4495ae8a31cd9c000b5b Signed-off-by: Guilherme Sanchez <guilhermesanchezpacheco@gmail.com> b5f31d70f1fac8d3fba325c9867a03f976775698 Merge branch 'master' of git@repos.giga.puc-rio.br:elua-doc.git ec9ad8446b7ea38b252c6a416e70774349835e45 files deleted bd7a80151b2030720ba8d8a303467d8c25a4b4b2 Changed function that creates functions submenus. 6a7494acaec694fadbb13520bcbccc51a6b95dfe Inserido menu com árvore, ajustes no CSS, busca do google e979f1c259d425c9a3be83f9cda20eddffe073bb Changed past design to new design. 381459e95286886b052103a0253e60b29e064d7a CSS updated 4f81d2f1195efe733fe5f97517be325d75937bc3 initial import
78 lines
2.7 KiB
Lua
78 lines
2.7 KiB
Lua
-- eLua platform interface - CAN
|
|
-- Make a full description for each language
|
|
|
|
data_en =
|
|
{
|
|
-- Menu name
|
|
menu_name = "CAN",
|
|
|
|
-- Title
|
|
title = "eLua platform interface - CAN",
|
|
|
|
-- Overview
|
|
overview = "This part of the platform interface groups functions related to the CAN interface(s) of the MCU..",
|
|
|
|
-- Data structures, constants and types
|
|
structures =
|
|
{
|
|
{ text = [[// eLua CAN ID types
|
|
enum
|
|
{
|
|
ELUA_CAN_ID_STD = 0,
|
|
ELUA_CAN_ID_EXT
|
|
};
|
|
]],
|
|
name = "CAN ID types",
|
|
desc = "Constants used to define whether the message ID is standard or extended.."
|
|
}
|
|
},
|
|
|
|
-- Functions
|
|
funcs =
|
|
{
|
|
{ sig = "int #platform_can_exists#( unsigned id );",
|
|
desc = [[Checks if the platform has the hardware CAN specified as argument. Implemented in %src/common.c%, it uses the $NUM_CAN$ macro that must be defined in the
|
|
platform's $platform_conf.h$ file (see @arch_overview.html#platforms@here@ for details). For example:</p>
|
|
~#define NUM_CAN 1 $// The platform has one CAN interface$~<p> ]],
|
|
args = "$id$ - CAN interface ID.",
|
|
ret = "1 if the CAN interface exists, 0 otherwise"
|
|
},
|
|
|
|
{ sig = "u32 #platform_can_setup#( unsigned id, u23 clock );",
|
|
desc = [[This function is used to initialize the CAN hardware and set the bus clock.]],
|
|
args =
|
|
{
|
|
"$id$ - CAN interface ID.",
|
|
"$clock$ - the clock of the CAN bus, maximum speed is generally 1000000 (1 Mbit)"
|
|
},
|
|
ret = "the actual speed set for the CAN interface. Depending on the hardware, this may have a different value than the $clock$ argument."
|
|
},
|
|
|
|
{ sig = "void #platform_can_send#( unsigned id, u32 canid, u8 idtype, u8 len, const u8 *data );",
|
|
desc = "Send message over the CAN bus.",
|
|
args =
|
|
{
|
|
"$id$ - CAN interface ID.",
|
|
"$canid$ - CAN identifier number.",
|
|
"$canidtype$ - identifier type as defined @#can_id_types@here@",
|
|
"$len$ - message length in bytes (8 or fewer)",
|
|
"$message$ - pointer to message, 8 or fewer bytes in length"
|
|
},
|
|
},
|
|
|
|
{ sig = "int #platform_can_recv#( unsigned id, u32 *canid, u8 *idtype, u8 *len, u8 *data );",
|
|
desc = "Receive CAN bus message.",
|
|
args =
|
|
{
|
|
"$id$ - CAN interface ID.",
|
|
"$canid$ - pointer where CAN identifier number will be written.",
|
|
"$canidtype$ - pointer where identifier type as defined @#can_id_types@here@ will be written",
|
|
"$len$ - pointer where message length in bytes will be written",
|
|
"$message$ - pointer to message buffer (8 bytes in lenth)"
|
|
},
|
|
ret = "PLATFORM_OK for success, PLATFORM_UNDERFLOW for error. (see @arch_platform_ll.html@here@ for details)"
|
|
},
|
|
}
|
|
}
|
|
|