Line data    Source code

       1              : /*
       2              :  *
       3              :  *    Copyright (c) 2025 Project CHIP Authors
       4              :  *    Copyright (c) 2025 NXP LLC.
       5              :  *
       6              :  *    Licensed under the Apache License, Version 2.0 (the "License");
       7              :  *    you may not use this file except in compliance with the License.
       8              :  *    You may obtain a copy of the License at
       9              :  *
      10              :  *        http://www.apache.org/licenses/LICENSE-2.0
      11              :  *
      12              :  *    Unless required by applicable law or agreed to in writing, software
      13              :  *    distributed under the License is distributed on an "AS IS" BASIS,
      14              :  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      15              :  *    See the License for the specific language governing permissions and
      16              :  *    limitations under the License.
      17              :  */
      18              : 
      19              : /**
      20              :  *    @file
      21              :  *      This file contains functions for working with WiFiPAF Layer errors.
      22              :  */
      23              : 
      24              : #include "WiFiPAFError.h"
      25              : 
      26              : #include <lib/core/ErrorStr.h>
      27              : 
      28              : namespace chip {
      29              : namespace WiFiPAF {
      30              : 
      31              : /**
      32              :  * Register a text error formatter for WiFiPAF Layer errors.
      33              :  */
      34            1 : void RegisterLayerErrorFormatter()
      35              : {
      36              :     static ErrorFormatter sWiFiPAFLayerErrorFormatter = { FormatLayerError, nullptr };
      37              : 
      38            1 :     RegisterErrorFormatter(&sWiFiPAFLayerErrorFormatter);
      39            1 : }
      40              : 
      41           17 : bool FormatLayerError(char * buf, uint16_t bufSize, CHIP_ERROR err)
      42              : {
      43           17 :     const char * desc = nullptr;
      44              : 
      45           17 :     if (!err.IsPart(ChipError::SdkPart::kBLE))
      46              :     {
      47            0 :         return false;
      48              :     }
      49              : 
      50           17 :     switch (err.AsInteger())
      51              :     {
      52            1 :     case WIFIPAF_ERROR_NO_CONNECTION_RECEIVED_CALLBACK.AsInteger():
      53            1 :         desc = "No chip over WiFiPAF connection received callback set";
      54            1 :         break;
      55            1 :     case WIFIPAF_ERROR_CHIPPAF_PROTOCOL_ABORT.AsInteger():
      56            1 :         desc = "WiFiPAF transport protocol fired abort";
      57            1 :         break;
      58            1 :     case WIFIPAF_ERROR_REMOTE_DEVICE_DISCONNECTED.AsInteger():
      59            1 :         desc = "Remote device closed WiFiPAF connection";
      60            1 :         break;
      61            1 :     case WIFIPAF_ERROR_APP_CLOSED_CONNECTION.AsInteger():
      62            1 :         desc = "Application closed WiFiPAF connection";
      63            1 :         break;
      64            1 :     case WIFIPAF_ERROR_INCOMPATIBLE_PROTOCOL_VERSIONS.AsInteger():
      65            1 :         desc = "Incompatible WiFiPAF transport protocol versions";
      66            1 :         break;
      67            1 :     case WIFIPAF_ERROR_INVALID_FRAGMENT_SIZE.AsInteger():
      68            1 :         desc = "Invalid fragment size";
      69            1 :         break;
      70            1 :     case WIFIPAF_ERROR_START_TIMER_FAILED.AsInteger():
      71            1 :         desc = "Start timer failed";
      72            1 :         break;
      73            1 :     case WIFIPAF_ERROR_CONNECT_TIMED_OUT.AsInteger():
      74            1 :         desc = "Connect handshake timed out";
      75            1 :         break;
      76            1 :     case WIFIPAF_ERROR_RECEIVE_TIMED_OUT.AsInteger():
      77            1 :         desc = "Receive handshake timed out";
      78            1 :         break;
      79            1 :     case WIFIPAF_ERROR_INVALID_MESSAGE.AsInteger():
      80            1 :         desc = "Invalid message";
      81            1 :         break;
      82            1 :     case WIFIPAF_ERROR_FRAGMENT_ACK_TIMED_OUT.AsInteger():
      83            1 :         desc = "Message fragment acknowledgement timed out";
      84            1 :         break;
      85            1 :     case WIFIPAF_ERROR_KEEP_ALIVE_TIMED_OUT.AsInteger():
      86            1 :         desc = "Keep-alive receipt timed out";
      87            1 :         break;
      88            1 :     case WIFIPAF_ERROR_NO_CONNECT_COMPLETE_CALLBACK.AsInteger():
      89            1 :         desc = "Missing required callback";
      90            1 :         break;
      91            1 :     case WIFIPAF_ERROR_INVALID_ACK.AsInteger():
      92            1 :         desc = "Received invalid WiFiPAF transport protocol fragment acknowledgement";
      93            1 :         break;
      94            1 :     case WIFIPAF_ERROR_REASSEMBLER_MISSING_DATA.AsInteger():
      95            1 :         desc = "WiFiPAF message reassembler did not receive enough data";
      96            1 :         break;
      97            1 :     case WIFIPAF_ERROR_INVALID_PAFTP_HEADER_FLAGS.AsInteger():
      98            1 :         desc = "Received invalid WiFiPAF transport protocol header flags";
      99            1 :         break;
     100            1 :     case WIFIPAF_ERROR_INVALID_PAFTP_SEQUENCE_NUMBER.AsInteger():
     101            1 :         desc = "Received invalid WiFiPAF transport protocol sequence number";
     102            1 :         break;
     103            0 :     default:
     104            0 :         return false;
     105              :     }
     106              : 
     107           17 :     FormatError(buf, bufSize, "WiFiPAF", err, desc);
     108              : 
     109           17 :     return true;
     110              : }
     111              : 
     112              : } /* namespace WiFiPAF */
     113              : } /* namespace chip */