Changes between Version 1 and Version 2 of spec/LdCom


Ignore:
Timestamp:
Dec 9, 2022, 4:01:19 PM (17 months ago)
Author:
fujisft-kaji
Comment:

R21-11反映

Legend:

Unmodified
Added
Removed
Modified
  • spec/LdCom

    v1 v2  
    77[[BR]]
    88
    9 {{{#!comment
    10 [執筆開始時削除エリア]ここから
    11 ※コメントごと削除してください
    12 }}}
    13 * '''本項目は、まだ執筆されていません'''
    14 * '''要望等ございましたら、[wiki: Wikiトップページ]にあります[wiki:#本サイトに関して 問い合わせ先]までお願いします'''
     9= 概要 =
     10
     11* API一覧
     12
     13  ||= API =||= ID[[BR]][Dec] =||= ID[[BR]][Hex] =||= R21-11 =||
     14  || [#LdCom_Init LdCom_Init]                                                     ||  1|| 0x01||  ○  ||
     15  || [#LdCom_DeInit LdCom_DeInit]                                                 ||  2|| 0x02||  ○  ||
     16  || [#LdCom_GetVersionInfo LdCom_GetVersionInfo]                                 ||  3|| 0x03||  ○  ||
     17  || [#LdCom_Transmit LdCom_Transmit]                                             || 73|| 0x49||  ○  ||
     18  || [#LdCom_CopyTxData LdCom_CopyTxData]                                         || 67|| 0x43||  ○  ||
     19  || [#LdCom_TpTxConfirmation LdCom_TpTxConfirmation]                             || 72|| 0x48||  ○  ||
     20  || [#LdCom_StartOfReception LdCom_StartOfReception]                             || 70|| 0x46||  ○  ||
     21  || [#LdCom_CopyRxData LdCom_CopyRxData]                                         || 68|| 0x44||  ○  ||
     22  || [#LdCom_TpRxIndication LdCom_TpRxIndication]                                 || 69|| 0x45||  ○  ||
     23  || [#LdCom_RxIndication LdCom_RxIndication]                                     || 66|| 0x42||  ○  ||
     24  || [#LdCom_TxConfirmation LdCom_TxConfirmation]                                 || 64|| 0x40||  ○  ||
     25  || [#LdCom_TriggerTransmit LdCom_TriggerTransmit]                               || 65|| 0x41||  ○  ||
     26  || [#LdComUser_LdComCbkCopyTxData <LdComUser_LdComCbkCopyTxData>]               || 74|| 0x4a||  ○  ||
     27  || [#LdComUser_LdComCbkTpTxConfirmation <LdComUser_LdComCbkTpTxConfirmation>]   || 75|| 0x4b||  ○  ||
     28  || [#LdComUser_LdComCbkStartOfReception <LdComUser_LdComCbkStartOfReception>]   || 76|| 0x4c||  ○  ||
     29  || [#LdComUser_LdComCbkCopyRxData <LdComUser_LdComCbkCopyRxData>]               || 77|| 0x4d||  ○  ||
     30  || [#LdComUser_LdComCbkTpRxIndication <LdComUser_LdComCbkTpRxIndication>]       || 78|| 0x4e||  ○  ||
     31  || [#LdComUser_LdComCbkRxIndication <LdComUser_LdComCbkRxIndication>]           || 79|| 0x4f||  ○  ||
     32  || [#LdComUser_LdComCbkTriggerTransmit <LdComUser_LdComCbkTriggerTransmit>]     || 80|| 0x50||  ○  ||
     33  || [#LdComUser_LdComCbkTxConfirmation <LdComUser_LdComCbkTxConfirmation>]       || 81|| 0x51||  ○  ||
     34
     35* コンフィギュレーション一覧 (R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11)
     36  * [#LdComConfig LdComConfig] (○/○/○/○/○/○)
     37    * [#LdComIPdu LdComIPdu] (○/○/○/○/○/○)
     38      * [#LdComApiType LdComApiType] (○/○/○/○/○/○)
     39      * [#LdComHandleId LdComHandleId] (○/○/○/○/○/○)
     40      * [#LdComIPduDirection LdComIPduDirection] (○/○/○/○/○/○)
     41      * [#LdComPduRef LdComPduRef] (○/○/○/○/○/○)
     42      * [#LdComRxCopyRxData LdComRxCopyRxData] (○/○/○/○/○/○)
     43      * [#LdComRxIndication LdComRxIndication] (○/○/○/○/○/○)
     44      * [#LdComRxStartOfReception LdComRxStartOfReception] (○/○/○/○/○/○)
     45      * [#LdComSystemTemplateSignalRef LdComSystemTemplateSignalRef] (○/○/○/○/○/○)
     46      * [#LdComTpRxIndication LdComTpRxIndication] (○/○/○/○/○/○)
     47      * [#LdComTpTxConfirmation LdComTpTxConfirmation] (○/○/○/○/○/○)
     48      * [#LdComTxConfirmation LdComTxConfirmation] (○/○/○/○/○/○)
     49      * [#LdComTxCopyTxData LdComTxCopyTxData] (○/○/○/○/○/○)
     50      * [#LdComTxTriggerTransmit LdComTxTriggerTransmit] (○/○/○/○/○/○)
     51    * [#LdComUserModule LdComUserModule] (-/-/-/-/-/○)
     52  * [#LdComGeneral LdComGeneral] (○/○/○/○/○/○)
     53    * [#LdComDevErrorDetect LdComDevErrorDetect] (○/○/○/○/○/○)
     54    * [#LdComVersionInfoApi LdComVersionInfoApi] (○/○/○/○/○/○)
     55
     56* エラーコード一覧
     57
     58  ||= エラーコード =||= Dec =||= Hex =||= R21-11 =||
     59  || LDCOM_E_UNINIT             ||  2|| 0x02||  ○  ||
     60  || LDCOM_E_PARAM_POINTER      ||  3|| 0x03||  ○  ||
     61  || LDCOM_E_INVALID_PDU_SDU_ID ||  4|| 0x04||  ○  ||
     62  || LDCOM_E_INVALID_SIGNAL_ID  ||  5|| 0x05||  ○  ||
     63  || LDCOM_E_INIT_FAILED        ||  6|| 0x06||  ○  ||
     64
    1565----
    16 {{{#!comment
    17 [執筆開始時削除エリア]ここまで
    18 ※コメントごと削除してください
    19 }}}
    20 
    21 = 概要 =
     66
     67= API仕様 =
     68
     69== LdCom_Init ==
     70{{{
     71void LdCom_Init (const LdCom_ConfigType* config)
     72}}}
     73
     74== LdCom_DeInit ==
     75{{{
     76void LdCom_DeInit (void)
     77}}}
     78
     79== LdCom_GetVersionInfo ==
     80{{{
     81void LdCom_GetVersionInfo (Std_VersionInfoType* versioninfo)
     82}}}
     83
     84== LdCom_Transmit ==
     85{{{
     86Std_ReturnType LdCom_Transmit (PduIdType Id, const PduInfoType* InfoPtr)
     87}}}
     88
     89== LdCom_CopyTxData ==
     90{{{
     91BufReq_ReturnType LdCom_CopyTxData (PduIdType id, const PduInfoType* info, const RetryInfoType* retry, PduLengthType* availableDataPtr)
     92}}}
     93
     94== LdCom_TpTxConfirmation ==
     95{{{
     96void LdCom_TpTxConfirmation (PduIdType id, Std_ReturnType result)
     97}}}
     98
     99== LdCom_StartOfReception ==
     100{{{
     101BufReq_ReturnType LdCom_StartOfReception (PduIdType id, const PduInfoType* info, PduLengthType TpSduLength, PduLengthType* bufferSizePtr)
     102}}}
     103
     104== LdCom_CopyRxData ==
     105{{{
     106BufReq_ReturnType LdCom_CopyRxData (PduIdType id, const PduInfoType* info, PduLengthType* bufferSizePtr)
     107}}}
     108
     109== LdCom_TpRxIndication ==
     110{{{
     111void LdCom_TpRxIndication (PduIdType id, Std_ReturnType result)
     112}}}
     113
     114== LdCom_RxIndication ==
     115{{{
     116void LdCom_RxIndication (PduIdType RxPduId, const PduInfoType* PduInfoPtr)
     117}}}
     118
     119== LdCom_TxConfirmation ==
     120{{{
     121void LdCom_TxConfirmation (PduIdType TxPduId, Std_ReturnType result)
     122}}}
     123
     124== LdCom_TriggerTransmit ==
     125{{{
     126Std_ReturnType LdCom_TriggerTransmit (PduIdType TxPduId, PduInfoType* PduInfoPtr)
     127}}}
     128
     129== <LdComUser_LdComCbkCopyTxData> ==
     130{{{
     131BufReq_ReturnType <LdComUser_LdComCbkCopyTxData> (CbkHandleIdType LdComUserCbkHandleId, const PduInfoType* info, const RetryInfoType* retry, PduLengthType* availableDataPtr)
     132}}}
     133
     134== <LdComUser_LdComCbkTpTxConfirmation> ==
     135{{{
     136void <LdComUser_LdComCbkTpTxConfirmation> (CbkHandleIdType LdComUserCbkHandleId, Std_ReturnType result)
     137}}}
     138
     139== <LdComUser_LdComCbkStartOfReception> ==
     140{{{
     141BufReq_ReturnType <LdComUser_LdComCbkStartOfReception> (CbkHandleIdType LdComUserCbkHandleId, const PduInfoType* info, PduLengthType TpSduLength, PduLengthType* bufferSizePtr)
     142}}}
     143
     144== <LdComUser_LdComCbkCopyRxData> ==
     145{{{
     146BufReq_ReturnType <LdComUser_LdComCbkCopyRxData> (CbkHandleIdType LdComUserCbkHandleId, const PduInfoType* info, PduLengthType* bufferSizePtr)
     147}}}
     148
     149== <LdComUser_LdComCbkTpRxIndication> ==
     150{{{
     151void <LdComUser_LdComCbkTpRxIndication> (CbkHandleIdType LdComUserCbkHandleId, Std_ReturnType result)
     152}}}
     153
     154== <LdComUser_LdComCbkRxIndication> ==
     155{{{
     156void <LdComUser_LdComCbkRxIndication> (CbkHandleIdType LdComUserCbkHandleId, const PduInfoType* PduInfoPtr)
     157}}}
     158
     159== <LdComUser_LdComCbkTriggerTransmit> ==
     160{{{
     161Std_ReturnType <LdComUser_LdComCbkTriggerTransmit> (CbkHandleIdType LdComUserCbkHandleId, PduInfoType* PduInfoPtr)
     162}}}
     163
     164== <LdComUser_LdComCbkTxConfirmation> ==
     165{{{
     166void <LdComUser_LdComCbkTxConfirmation> (CbkHandleIdType LdComUserCbkHandleId, Std_ReturnType result)
     167}}}
    22168
    23169----
    24170
    25 = API仕様 =
    26 
    27 ----
    28 
    29171= コンフィギュレーション仕様 =
     172
     173== LdComConfig ==
     174{{{
     175/AUTOSAR/EcucDefs/LdCom/LdComConfig
     176}}}
     177* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     178* SWSタグ: ECUC_LdCom_00003
     179* タイプ: PARAM-CONF-CONTAINER
     180* 多重度: 1
     181
     182== LdComIPdu ==
     183{{{
     184/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu
     185}}}
     186* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     187* SWSタグ: ECUC_LdCom_00006
     188* タイプ: PARAM-CONF-CONTAINER
     189* 多重度: 0..*
     190
     191== LdComApiType ==
     192{{{
     193/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComApiType
     194}}}
     195* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     196* SWSタグ: ECUC_LdCom_00002
     197* タイプ: ENUMERATION-PARAM
     198* 多重度: 1
     199* 選択肢:
     200  * LDCOM_IF
     201  * LDCOM_TP
     202
     203== LdComHandleId ==
     204{{{
     205/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComHandleId
     206}}}
     207* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     208* SWSタグ: ECUC_LdCom_00005
     209* タイプ: INTEGER-PARAM
     210* 多重度: 1
     211* 上限値: 65535
     212* 下限値: 0
     213
     214== LdComIPduDirection ==
     215{{{
     216/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComIPduDirection
     217}}}
     218* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     219* SWSタグ: ECUC_LdCom_00007
     220* タイプ: ENUMERATION-PARAM
     221* 多重度: 1
     222* 選択肢:
     223  * LDCOM_RECEIVE
     224  * LDCOM_SEND
     225
     226== LdComPduRef ==
     227{{{
     228/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComPduRef
     229}}}
     230* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     231* SWSタグ: ECUC_LdCom_00010
     232* タイプ: REFERENCE
     233* 多重度: 1
     234* 参照先: [wiki:spec/EcuC#Pdu /AUTOSAR/EcucDefs/EcuC/EcucConfigSet/EcucPduCollection/Pdu]
     235
     236== LdComRxCopyRxData ==
     237{{{
     238/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComRxCopyRxData
     239}}}
     240* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     241* SWSタグ: ECUC_LdCom_00013
     242* タイプ: FUNCTION-NAME
     243* 多重度: 0..1
     244
     245== LdComRxIndication ==
     246{{{
     247/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComRxIndication
     248}}}
     249* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     250* SWSタグ: ECUC_LdCom_00014
     251* タイプ: FUNCTION-NAME
     252* 多重度: 0..1
     253
     254== LdComRxStartOfReception ==
     255{{{
     256/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComRxStartOfReception
     257}}}
     258* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     259* SWSタグ: ECUC_LdCom_00015
     260* タイプ: FUNCTION-NAME
     261* 多重度: 0..1
     262
     263== LdComSystemTemplateSignalRef ==
     264{{{
     265/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComSystemTemplateSignalRef
     266}}}
     267* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     268* SWSタグ: ECUC_LdCom_00011
     269* タイプ: FOREIGN-REFERENCE
     270* 多重度: 0..1
     271* 参照先タイプ: I-SIGNAL-TO-I-PDU-MAPPING
     272
     273== LdComTpRxIndication ==
     274{{{
     275/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComTpRxIndication
     276}}}
     277* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     278* SWSタグ: ECUC_LdCom_00016
     279* タイプ: FUNCTION-NAME
     280* 多重度: 0..1
     281
     282== LdComTpTxConfirmation ==
     283{{{
     284/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComTpTxConfirmation
     285}}}
     286* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     287* SWSタグ: ECUC_LdCom_00017
     288* タイプ: FUNCTION-NAME
     289* 多重度: 0..1
     290
     291== LdComTxConfirmation ==
     292{{{
     293/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComTxConfirmation
     294}}}
     295* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     296* SWSタグ: ECUC_LdCom_00021
     297* タイプ: FUNCTION-NAME
     298* 多重度: 0..1
     299
     300== LdComTxCopyTxData ==
     301{{{
     302/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComTxCopyTxData
     303}}}
     304* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     305* SWSタグ: ECUC_LdCom_00018
     306* タイプ: FUNCTION-NAME
     307* 多重度: 0..1
     308
     309== LdComTxTriggerTransmit ==
     310{{{
     311/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComIPdu/LdComTxTriggerTransmit
     312}}}
     313* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     314* SWSタグ: ECUC_LdCom_00019
     315* タイプ: FUNCTION-NAME
     316* 多重度: 0..1
     317
     318== LdComUserModule ==
     319{{{
     320/AUTOSAR/EcucDefs/LdCom/LdComConfig/LdComUserModule
     321}}}
     322* 対象リビジョン: R21-11
     323* SWSタグ: ECUC_LdCom_00029
     324* タイプ: PARAM-CONF-CONTAINER
     325* 多重度: 0..*
     326
     327== LdComGeneral ==
     328{{{
     329/AUTOSAR/EcucDefs/LdCom/LdComGeneral
     330}}}
     331* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     332* SWSタグ: ECUC_LdCom_00004
     333* タイプ: PARAM-CONF-CONTAINER
     334* 多重度: 1
     335
     336== LdComDevErrorDetect ==
     337{{{
     338/AUTOSAR/EcucDefs/LdCom/LdComGeneral/LdComDevErrorDetect
     339}}}
     340* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     341* SWSタグ: ECUC_LdCom_00020
     342* タイプ: BOOLEAN-PARAM
     343* 多重度: 1
     344* デフォルト値:
     345  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: false
     346
     347== LdComVersionInfoApi ==
     348{{{
     349/AUTOSAR/EcucDefs/LdCom/LdComGeneral/LdComVersionInfoApi
     350}}}
     351* 対象リビジョン: R4.2.2/R4.3.1/R4.4.0/R19-11/R20-11/R21-11
     352* SWSタグ: ECUC_LdCom_00012
     353* タイプ: BOOLEAN-PARAM
     354* 多重度: 1
     355* デフォルト値:
     356  * R4.3.1/R4.4.0/R19-11/R20-11/R21-11: false