From 8f091482acf0eded53d8d9ab7952e934c5e54197 Mon Sep 17 00:00:00 2001 From: Nick James Kirkby <20824939+driftregion@users.noreply.github.com> Date: Sun, 21 Jan 2024 11:50:47 -0700 Subject: [PATCH] remove zh lang docs, add AUTHORS.txt, tidy README.md --- AUTHORS.txt | 2 + BUILD | 2 +- README.md | 317 +++----------------------------------- README_zh.md | 409 ------------------------------------------------- test/README.md | 16 +- 5 files changed, 23 insertions(+), 723 deletions(-) create mode 100644 AUTHORS.txt delete mode 100644 README_zh.md diff --git a/AUTHORS.txt b/AUTHORS.txt new file mode 100644 index 0000000..54e074a --- /dev/null +++ b/AUTHORS.txt @@ -0,0 +1,2 @@ +Nick James Kirkby +Mark Corbin diff --git a/BUILD b/BUILD index 9f8e250..8dc4dd7 100644 --- a/BUILD +++ b/BUILD @@ -49,8 +49,8 @@ genrule( "iso14229.c", "iso14229.h", "README.md", - "README_zh.md", "LICENSE", + "AUTHORS.txt", ], outs = ["iso14229.zip"], cmd = "mkdir iso14229 && cp -L $(SRCS) iso14229/ && zip -r $(OUTS) iso14229", diff --git a/README.md b/README.md index 8d3447e..0f35866 100644 --- a/README.md +++ b/README.md @@ -5,35 +5,32 @@

-

- 简体中文 -

- -iso14229 is an implementation of UDS (ISO14229-1:2013) targeting embedded systems. It is tested with [`isotp-c`](https://github.com/lishen2/isotp-c) as well as [linux kernel](https://github.com/linux-can/can-utils/blob/master/include/linux/can/isotp.h) ISO15765-2 (ISO-TP) transport layer implementations. +iso14229 is an implementation of UDS (ISO14229) targeting embedded systems. It is tested with [`isotp-c`](https://github.com/lishen2/isotp-c) as well as [linux kernel](https://github.com/linux-can/can-utils/blob/master/include/linux/can/isotp.h) ISO15765-2 (ISO-TP) transport layer implementations. API status: **not yet stable**. -## Quickstart +## Using this library 1. Download `iso14229.zip` from the [releases page](https://github.com/driftregion/iso14229/releases), copy `iso14229.c` and `iso14229.h` into your source tree and build. -2. See [examples](./examples). +2. Look at the [examples](./examples) -## Building +## Build Systems -iso14229 uses bazel internally. You do not need bazel to use this library. +iso14229 is designed to build on any platform. ## Preprocessor Defines | Define | Description | Valid values | | - | - | - | -| `UDS_TP` | Enable a transport layer | see `tp.h` | -| `UDS_SYS` | Select a porting target | see `sys.h` | -| `UDS_...` | Additional compile-time config options | see `config.h` | +| `-DUDS_TP_ISOTP_C` | build the isotp-c transport layer (recommended for bare-metal systems) | on/off | +| `-DUDS_TP_ISOTP_SOCK` | build the isotp socket transport layer (recommended for linux) | on/off| +| `-DUDS_TP_ISOTP_C_SOCKETCAN` | build the isotp-c transport layer with socketcan support (linux-only) | on/off| +| `UDS_...` | Additional configuration options | see [`src/config.h`](src/config.h) | +| `UDS_SYS` | Selects target system | see [`src/sys.h`](src/sys.h) | ## Features -- static memory allocation. does not use `malloc`, `calloc` -- easy to integrate. Download `iso14229.c` and `iso14229.h` from the releases page and copy into your source tree. +- entirely static memory allocation. (no `malloc`, `calloc`, ...) - highly portable and tested - architectures: arm, x86-64, ppc, ppc64, risc - systems: linux, Windows, esp32, Arduino, NXP s32k @@ -69,11 +66,15 @@ iso14229 uses bazel internally. You do not need bazel to use this library. | 0x85 | control DTC setting | ✅ | | 0x86 | response on event | ❌ | +## Running Tests + +See [test_all.sh](./test_all.sh) and [test/README.md](test/README.md) + # Documentation ## Server Events -see `enum UDSServerEvent` in [iso14229.h](./iso14229.h) +see `enum UDSServerEvent` in [src/uds.h](src/uds.h) ### `UDS_SRV_EVT_DiagSessCtrl` (0x10) @@ -330,12 +331,10 @@ contributions are welcome - [`isotp-c`](https://github.com/lishen2/isotp-c) which this project embeds -# License - -MIT - # Changelog +## 0.7.1 +- amalgamated sources into `iso14229.c` and `iso14229.h` to ease integration ## 0.7.0 - test refactoring. theme: test invariance across different transports and processor architectures @@ -392,283 +391,3 @@ MIT ## 0.0.0 - initial release - ---- - -# Design Docs - -## ISO-TP interface - -`iso14229` supports opaque transports. Use `Iso14229TpHandle_t` to wrap a transport. - - -### PDU transmission complete - -ISO14229-1 2013 6.1 describes a request-confirmation primitive to "indicate that the date passed in the service request primitive is successfully sent on the vehicle communication bus the diagnostic tester is connected to" - - -#### ISOTP-C -- **polling** -- `IsoTpLink.send_status` is either `IDLE`, `INPROGRESS`, or `ERROR` - -#### PCAN-ISO-TP -- **polling** - - https://www.peak-system.com/PCAN-ISO-TP-API.372.0.html - - `PCAN-ISO-TP_2016.h` contains a function for reading the transport status which includes `PCANTP_ISOTP_MSGTYPE_FLAG_INDICATION_TX` - -#### linux kernel isotp driver -- **blocking** -- https://github.com/hartkopp/can-isotp/issues/27 (Get status of transmission?) -- https://github.com/hartkopp/can-isotp/issues/51 - - -If you're using the linux kernel driver, then you have threads and can use the excellent `python-udsoncan` to implement a client. - ----- -- "The Functional addressing is applied only to single frame transmission" -- Specification of Diagnostic Communication (Diagnostic on CAN - Network Layer) -- - -```plantuml -@startuml - -@enduml -``` - -## Client State Machine - -```plantuml -@startuml -title 客户端请求状态机 -note as N1 -enum { - kNoError=0, - kErrBadRequest, - kErrP2Timeout, -} ClientErr; - -static inline bool isRequestComplete() {return state==Idle;} - -while (Idle != client->state) { - receiveCAN(client); - UDSClientPoll(client); -} -end note - -state Idle -state Sending -state Sent -state SentAwaitResponse -state ProcessResponse -Idle: if (ISOTP_RET_OK == isotp_receive(...)) // Error -ProcessResponse: isotp_receive() -ProcessResponse: _ClientValidateResponse(...) -ProcessResponse: _ClientHandleResponse(...) - -Sending --> Sent: 传输层完成传输 - -Sent --> Idle : suppressPositiveResponse -Sending --> SentAwaitResponse: !suppressPositiveResponse -SentAwaitResponse -> Idle: 响应收到了 ||\np2 超时 -SentAwaitResponse --> ProcessResponse : ISOTP_RECEIVE_STATUS_FULL == link->receive_status -ProcessResponse --> Idle - -[*] -> Idle -Idle -> Sending : _SendRequest() - -@enduml -``` - -```plantuml -@startuml -title Request Lifecycle -alt normal - alt positive response - client --> client: Sending - client -> server : *Any* Service - client --> client: SentAwaitResponse: set p2 - alt 0x78 requestCorrectlyReceived-ResponsePending - server -> client : 0x3F 0x78 - client -->server : txLink idle - client --> client: SentAwaitResponse: set p2star - end - server -> client : Positive Service Response - client --> client: Idle - else negative response - server -> client !! : Negative Service Response - client --> client: Idle: RequestErrorNegativeResponse - else SID mismatch - server -> client !! : Mismatched Service Response - client --> client: Idle: RequestErrorResponseSIDMismatch - end -else unexpected response - server -> client !! : Unexpected Response - client --> client: Idle: RequestErrorUnsolicitedResponse -end -@enduml -``` - - -```plantuml -@startuml -' !pragma useVerticalIf on -title 客户端请求流程 -start - -:clientSendRequest(); -if (验证参数) then (对) -:ok; -else (不对) -:foo; -detach -endif - -:clearRequestContext(); -if (等待UDS访问) then (访问接收了,进入UDS会话) -else (时间超过20ms) -@enduml -``` - -## Server 0x78 requestCorrectlyReceived-ResponsePending - -```plantuml -@startuml -client -> server : *Any* Service -server -> userServiceHandler: handler(args) -note right: Doing this will take a long time\nso I return 0x78 -userServiceHandler -> server: 0x78 -server -> client : 0x3F 0x78 -client -->server : txLink idle -server -> userServiceHandler: handler(args) -note right: actually call the long-running service -... p2* > t > p2 ... -userServiceHandler -> server : Service Response -server -> client : Service Response -@enduml -``` - - -```plantuml -@startuml -' !pragma useVerticalIf on -title UDSServerPoll Flowchart -|Server| -start - -if (DefaultSession != sessionType \n&& s3_timeout) then (true) -:Emit SessionTimeout; -else (false) -endif - -if (ecuResetScheduled\n&& ecuResetTimer) then (false) -else (true) -:Emit DoScheduledReset; -endif - -if (tp_status & TP_SEND_IN_PROGRESS) then (false) -:UDSTpPeek(); -else (true) -stop -endif - -:evaluateServiceResponse(); -|User| -:resp = handler(); -|Server| -if (resp) then (anything else) -else (0x78) - fork - |Server| - :wait p2 ms; - :send response (0x78); - repeat - if (time after p2*) then (yes) - :send response (0x78); - else (no) - endif - :wait 1ms; - repeat while (resp) is (0x78 RCRRP) - ->anything else; - - ' while (resp) is (0x78 RCRRP) - ' :wait p2* ms; - ' :send response (0x78); - ' endwhile (not 0x78 RCRRP) - - fork again - while (resp) is (0x78 RCRRP) - :evaluateServiceResponse(); - |User| - :resp = handler(); - |Server| - :wait 1ms; - endwhile (not 0x78 RCRRP) - end fork -endif -|Server| -:wait p2 ms; -:send response; -:UDSTpAckRecv(); - - -@enduml -``` - -```plantuml -@startuml -!pragma teoz true -title Service Processing -participant client -participant server -participant fn -{t1} client -> server : request -activate server -server -> fn: call() -fn -> server -{t2} server -> client: response -deactivate server -{t1} <-> {t2} : p2_server - -@enduml -``` - - -```plantuml -@startuml -title UDSServerPoll() Request Lifecycle -[*] -> UDSTpPeek -UDSTpPeek -> UDSTpPeek: recv_len == 0 -UDSTpPeek --> evaluateServiceResponse: recv_len > 0 &&\n !notReadyToReceive - -@enduml -``` - - -```plantuml -@startuml -' !pragma useVerticalIf on -title 0x78流程(写flash) -start - -:BufferedWriterWrite(BufferedWriter *self, const uint8_t *ibuf, uint32_t size, bool RCRRP); - -if (RCRRP) then (true) -:write to flash; -else (false) -endif -if (iBufIdx == size) then (true) - :write to pageBuffer; - :iBufIdx = 0; - :return kBufferedWriterWritePending; - :0x78 RCRRP; - detach; -else (false) - :memmove(pageBuffer + pageBufIdx, iBuf + iBufIdx, size - iBufIdx); - :write to pageBuffer; - :iBufIdx += size; - :0x01 PositiveResponse; - :0x78 RCRRP; - detach -endif - -@enduml -``` diff --git a/README_zh.md b/README_zh.md deleted file mode 100644 index 8a0b02b..0000000 --- a/README_zh.md +++ /dev/null @@ -1,409 +0,0 @@ -# iso14229 - -

-Build Status - -

- -iso14229是个针对嵌入式系统的UDS(ISO14229-1:2013)服务器和客户端会话层实现。为了让你能够更快上手、本库已包含[`isotp-c`](https://github.com/lishen2/isotp-c)以及linux内核ISO15765-2 (ISO-TP)传输层实现。 - -API状态: **未稳定** - -## 快速上手: 服务器 - -```c -#include "iso14229.h" - -static uint8_t fn(UDSServer_t *srv, UDSServerEvent_t ev, const void *arg) { - switch (ev) { - case UDS_SRV_EVT_EcuReset: { // 0x10 - UDSECUResetArgs_t *r = (UDSECUResetArgs_t *)arg; - printf("got ECUReset request of type %x\n", r->type); - return kPositiveResponse; - default: - return kServiceNotSupported; - } - } -} - -int main() { - UDSServer_t server; - UDSServerConfig_t cfg = { - .fn = &fn, - }; - UDSServerInit(&server, &cfg); - for (;;) { - UDSServerPoll(&server); - } -} -``` - -## 快速上手: 客户端 - -```c -// 参考 examples/client.c -``` - -特点: -- 静态内存分配 -- 独立于处理器架构 测试了: arm, x86-64, ppc, ppc64。参考[test_qemu.py](./test_qemu.py) -- 单元测试又多又容易扩展 - -## 支持服务(服务器和客户端) - -| SID | 英文名 | 支持 | -| - | - | - | -| 0x10 | diagnostic session control | ✅ | -| 0x11 | ECU reset | ✅ | -| 0x14 | clear diagnostic information | ❌ | -| 0x19 | read DTC information | ❌ | -| 0x22 | read data by identifier | ✅ | -| 0x23 | read memory by address | ❌ | -| 0x24 | read scaling data by identifier | ❌ | -| 0x27 | security access | ✅ | -| 0x28 | communication control | ✅ | -| 0x2A | read periodic data by identifier | ❌ | -| 0x2C | dynamically define data identifier | ❌ | -| 0x2E | write data by identifier | ✅ | -| 0x2F | input control by identifier | ❌ | -| 0x31 | routine control | ✅ | -| 0x34 | request download | ✅ | -| 0x35 | request upload | ✅ | -| 0x36 | transfer data | ✅ | -| 0x37 | request transfer exit | ✅ | -| 0x38 | request file transfer | ❌ | -| 0x3D | write memory by address | ❌ | -| 0x3E | tester present | ✅ | -| 0x83 | access timing parameter | ❌ | -| 0x84 | secured data transmission | ❌ | -| 0x85 | control DTC setting | ✅ | -| 0x86 | response on event | ❌ | - -# 文档 - -## 服务器事件 - -参考[iso14229.h](./iso14229.h) `enum UDSServerEvent` - -### `UDS_SRV_EVT_DiagSessCtrl` (0x10) 会话控制 - -#### 参数 - -```c -typedef struct { - const enum UDSDiagnosticSessionType type; /**< 请求会话类型 */ - uint16_t p2_ms; /**< 可选返回值: p2时间设置 */ - uint32_t p2_star_ms; /**< 可选返回值: p2*时间设置 */ -} UDSDiagSessCtrlArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 允许进入请求中的会话类型 | -| `0x12` | `kSubFunctionNotSupported` | 本器不支持请求中的会话类型 | -| `0x22` | `kConditionsNotCorrect` | 本器当前无法进入请求的会话类型 | - -### `UDS_SRV_EVT_ECUReset` (0x11) ECU复位 - -#### 参数 - -```c -typedef struct { - const enum UDSECUResetType type; /**< 请求的复位类型 */ - uint8_t powerDownTime; /**< 可选返回值: 通知客户端离关机的时间(0-254秒) 255表示无法判断具体关机时间*/ -} UDSECUResetArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 允许复位 | -| `0x12` | `kSubFunctionNotSupported` | 本器不支持请求的复位类型 | -| `0x22` | `kConditionsNotCorrect` | 本器目前无法复位 | -| `0x33` | `kSecurityAccessDenied` | 当前安全级别不允许复位 | - -### `UDS_SRV_EVT_ReadDataByIdent` (0x22) 读取数据 - -#### 参数 - -```c -typedef struct { - const uint16_t dataId; /*! 数据标识符 */ - /*! 函数：拷贝数据到服务器发送缓冲器. 成功会返回`kPositiveResponse`。若数据大小超过了服务器发送缓冲器的大小、会返回`kResponseTooLong`。*/ - const uint8_t (*copy)(UDSServer_t *srv, const void *src, - uint16_t count); -} UDSRDBIArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 允许读取 (注意调用`copy(...)`) | -| `0x14` | `kResponseTooLong` | 响应大小超过发送缓冲器大小 | -| `0x31` | `kRequestOutOfRange` | 请求的标识符不支持 | -| `0x33` | `kSecurityAccessDenied` | 当前安全级别不允许读取请求的数据标识符 | - -### `UDS_SRV_EVT_SecAccessRequestSeed`, `UDS_SRV_EVT_SecAccessValidateKey` (0x27) 安全访问 - -#### 参数 - -```c -typedef struct { - const uint8_t level; /*! 请求安全级别 */ - const uint8_t *const dataRecord; /*! 请求数据 */ - const uint16_t len; /*! 请求数据大小 */ - /*! 函数：拷贝数据到服务器发送缓冲器. 成功会返回`kPositiveResponse`。若数据大小超过了服务器发送缓冲器的大小、会返回`kResponseTooLong`。*/ - uint8_t (*copySeed)(UDSServer_t *srv, const void *src, - uint16_t len); -} UDSSecAccessRequestSeedArgs_t; - -typedef struct { - const uint8_t level; /*! 请求安全访问级别 */ - const uint8_t *const key; /*! 客户端发过来的密钥 */ - const uint16_t len; /*! 密钥大小 */ -} UDSSecAccessValidateKeyArgs_t; -``` -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x12` | `kSubFunctionNotSupported` | 该安全级别未支持 | -| `0x22` | `kConditionsNotCorrect` | 当前无法处理该请求 | -| `0x31` | `kRequestOutOfRange` | `dataRecord`的数据无效 | -| `0x35` | `kInvalidKey` | 密钥对不上 | -| `0x36` | `kExceededNumberOfAttempts` | 密码错误太多 | -| `0x37` | `kRequiredTimeDelayNotExpired` | 不晓得 | - -### `UDS_SRV_EVT_CommCtrl` (0x28) 通讯控制 - -#### 参数 - -```c -typedef struct { - enum UDSCommunicationControlType ctrlType; - enum UDSCommunicationType commType; -} UDSCommCtrlArgs_t; -``` -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x12` | `kSubFunctionNotSupported` | 请求中的通讯控制类型未支持 | -| `0x22` | `kConditionsNotCorrect` | 当前无法开启/关闭请求中的通讯控制类型| -| `0x31` | `kRequestOutOfRange` | 请求中的通讯控制类型或者通讯类型有错 | - -### `UDS_SRV_EVT_WriteDataByIdent` (0x2E) 写入数据 - -#### 参数 - -```c -typedef struct { - const uint16_t dataId; /*! 数据标识符 */ - const uint8_t *const data; /*! 数据 */ - const uint16_t len; /*! 数据大小 */ -} UDSWDBIArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 写入成功 | -| `0x22` | `kConditionsNotCorrect` | 当前无法写入 | -| `0x31` | `kRequestOutOfRange` | 数据标识符不支持或者数据内容有错 | -| `0x33` | `kSecurityAccessDenied` | 当前安全级别不允许写入请求中的数据标识符 | -| `0x72` | `kGeneralProgrammingFailure` | 写入内存失败 | - -### `UDS_SRV_EVT_RoutineCtrl` (0x31) 例程控制 - -#### 参数 - -```c -typedef struct { - const uint8_t ctrlType; /*! 例程控制类型 */ - const uint16_t id; /*! 例程标识符 */ - const uint8_t *optionRecord; /*! 客户端可选数据 */ - const uint16_t len; /*! 数据大小 */ - /*! 函数：拷贝数据到服务器发送缓冲器. 成功会返回`kPositiveResponse`。若数据大小超过了服务器发送缓冲器的大小、会返回`kResponseTooLong`。*/ - uint8_t (*copyStatusRecord)(UDSServer_t *srv, const void *src, - uint16_t len); -} UDSRoutineCtrlArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x22` | `kConditionsNotCorrect` | 当前无法操作 | -| `0x24` | `kRequestSequenceError` | 要求停止但未开始。要求开始但已开始(可选)。没有结果因为例程从来没有开始。| -| `0x31` | `kRequestOutOfRange` | 请求中的例程标识符未支持或者`optionRecord`无效 | -| `0x33` | `kSecurityAccessDenied` | 当前安全访问级别不允许请求的操作 | -| `0x72` | `kGeneralProgrammingFailure` | 内部内存操作失败(如：擦除flash) | - - -### `UDS_SRV_EVT_RequestDownload` (0x34) 请求下载 - -#### 参数 - -```c -typedef struct { - const void *addr; /*! 请求下载地址 */ - const size_t size; /*! 请求下载大小 */ - const uint8_t dataFormatIdentifier; /*! 可选：数据格式标识符 */ - uint16_t maxNumberOfBlockLength; /*! 返回值: 通知客户端能接受的`TransferData`长度是多长 */ -} UDSRequestDownloadArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x22` | `kConditionsNotCorrect` | 当前无法操作 | -| `0x31` | `kRequestOutOfRange` | `dataFormatIdentifier`,`addr`或者`size`无效。 | -| `0x33` | `kSecurityAccessDenied` | 当前安全访问级别不允许请求的操作 | -| `0x34` | `kAuthenticationRequired` | 客户端权利不足 | -| `0x70` | `kUploadDownloadNotAccepted` | 因故障无法下载 | - -### `UDS_SRV_EVT_TransferData` (0x36) 传输数据 - -#### 参数 - -```c -typedef struct { - const uint8_t *const data; /*! 数据 */ - const uint16_t len; /*! 数据大小 */ - /*! 函数：拷贝数据到服务器发送缓冲器. 成功会返回`kPositiveResponse`。若数据大小超过了服务器发送缓冲器的大小、会返回`kResponseTooLong`。*/ - uint8_t (*copyResponse)( - UDSServer_t *srv, const void *src, - uint16_t len); -} UDSTransferDataArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x31` | `kRequestOutOfRange` | `data`内容无效或者大小不对 | -| `0x72` | `kGeneralProgrammingFailure` | 写入内存失败 | -| `0x92` | `kVoltageTooHigh` | 无法写flash：电压过高 | -| `0x93` | `kVoltageTooLow` | 无法写flash：电压过低 | - -### `UDS_SRV_EVT_RequestTransferExit` (0x37) 请求传输结束 - -#### 参数 - -```c -typedef struct { - const uint8_t *const data; /*! 数据 */ - const uint16_t len; /*! 数据大小 */ - /*! 函数：拷贝数据到服务器发送缓冲器. 成功会返回`kPositiveResponse`。若数据大小超过了服务器发送缓冲器的大小、会返回`kResponseTooLong`。*/ - uint8_t (*copyResponse)(UDSServer_t *srv, const void *src, - uint16_t len); -} UDSRequestTransferExitArgs_t; -``` - -#### 支持返回值 - -| 值 | 枚举 | 意义 | -| - | - | - | -| `0x00` | `kPositiveResponse` | 肯定响应 | -| `0x31` | `kRequestOutOfRange` | `data`内容无效或者大小不对 | -| `0x72` | `kGeneralProgrammingFailure` | 完成数据传输失败 | - -## 例子 - -[examples/README.md](examples/README.md) - -### 运行测试 - -```sh -make test -``` - -## qemu - -```sh -CC=powerpc-linux-gnu-gcc make test_bin -qemu-ppc -L /usr/powerpc-linux-gnu test_bin -``` -## wine - -```sh -CC=x86_64-w64-mingw32-gcc make test_bin -wine test_bin.exe -``` - - -# 贡献 - -欢迎提交贡献 - - -# 感谢 - -- [`isotp`](https://github.com/lishen2/isotp-c) which this project embeds - -# 许可 - -MIT - -# 变更记录 - -## 0.6.0 -- API更改: - - `UDSClientErr_t`合并到`UDSErr_t` - - `TP_SEND_INPROGRESS`改名为`UDS_TP_SEND_IN_PROGRESS` - - 重构了`UDSTpHandle_t` - - `UDS_TP_LINUX_SOCKET`改名为`UDS_TP_ISOTP_SOCKET` -- 增加了服务器fuzz测试以及qemu测试 -- 整理例子测试,例子增加了isotp-c/socketcan传输 -- 增加了`UDS_SRV_EVT_DoScheduledReset`服务器事件 - -## 0.5.0 -- 可用性: 重构成单个.c/.h模块 -- 可用性: 默认传输层配置现在自带 -- API整理: 用`UDS`前缀在所有导出函数上 -- API整理: 服务器事件用单个回调函数 - -## 0.4.0 -- 重构RDBIHandler：用安全memmove -- 尽可能不用enum在结构体里面 -- 传输层可插件。现在支持linux内核ISO-TP驱动。`isotp-c`同时也支持。看看例子 [examples](./examples/README.md) - -## 0.3.0 -- 加`udsClientRunSequenceBlocking(...)` -- 加了服务器和客户端例子 -- 简化测试流程、删掉了过分模糊宏定义和switch结构 -- 服务器和客户端结构体简化：尽量用一层深度 -- 简化使用、放isotp-c初始化参数到服务器/客户端配置里面 -- 删除重复服务器缓冲器 - -## 0.2.0 -- 删除所有`__attribute__((packed))` -- 为了简化测试、重构服务器下载功能单元 -- 重构测试 - - 按服务排列 - - 给宏定义写文档 -- 删掉了中间件 -- 简化了服务器例程控制API -- 删掉了重复函数`udsServerEnableService` -- 更新例子 - -## 0.1.0 -- 加客户端 -- 加服务器SID 0x27安全访问 -- API更改 - -## 0.0.0 -- 初次发布 - ---- diff --git a/test/README.md b/test/README.md index 982cdb0..9a66df7 100644 --- a/test/README.md +++ b/test/README.md @@ -1,8 +1,7 @@ - +Testing aims to cover: - processor architecture (x86, ARM M4, PPC, ...) - transport layer implementation - - fault injection - fuzzing - style @@ -46,15 +45,4 @@ If building fails with `/usr/bin/ld: cannot find -lstdc++: No such file or direc ```sh sudo apt install libc++-15-dev libc++abi-15-dev sudo ln -s /usr/lib/x86_64-linux-gnu/libstdc++.so /usr/lib/x86_64-linux-gnu/libstdc++.so.6.0.30 -``` - - -# Why? - -Why bazel? - -> It's the best way I know to rigidly define multiple toolchains and architectures - -Why cmocka? - -> It is c \ No newline at end of file +``` \ No newline at end of file