Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply API review fixes for MTROTAHeaderParser. #23479

Merged
merged 1 commit into from
Nov 3, 2022
Merged

Apply API review fixes for MTROTAHeaderParser. #23479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/darwin-framework-tool/commands/provider/OTASoftwareUpdateInteractive.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
}

NSError * error;
return [MTROTAHeaderParser headerFromData:[NSData dataWithBytes:buffer.data() length:buffer.size()] error:&error];
return [MTROTAHeader headerFromData:[NSData dataWithBytes:buffer.data() length:buffer.size()] error:&error];
}

// Parses the JSON filepath and extracts DeviceSoftwareVersionModel parameters
Expand Down
8 changes: 7 additions & 1 deletion ...arwin/Framework/CHIP/MTROTAHeaderParser.h → src/darwin/Framework/CHIP/MTROTAHeader.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

#import <Foundation/Foundation.h>

/**
* A representation of an OTA image header as defined in the Matter
* specification's "Over-the-Air (OTA) Software Update File Format" section.
*/

NS_ASSUME_NONNULL_BEGIN

typedef NS_ENUM(NSUInteger, MTROTAImageDigestType) {
Expand All @@ -39,7 +44,6 @@ typedef NS_ENUM(NSUInteger, MTROTAImageDigestType) {
/**
* The identifier of the vendor whose product this image is meant for.
*
*
* This field can be compared to the vendor id received in the Query Image
* command to determine whether an image matches.
*
Expand Down Expand Up @@ -101,8 +105,10 @@ typedef NS_ENUM(NSUInteger, MTROTAImageDigestType) {
*/
@property (nonatomic, copy, nullable) NSNumber * maxApplicableVersion;

+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error MTR_NEWLY_AVAILABLE;
@end

MTR_NEWLY_DEPRECATED("Please use [MTROTAHeader headerFromData]")
@interface MTROTAHeaderParser : NSObject
+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error;
@end
Expand Down
22 changes: 16 additions & 6 deletions ...rwin/Framework/CHIP/MTROTAHeaderParser.mm → src/darwin/Framework/CHIP/MTROTAHeader.mm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

#import "MTROTAHeaderParser.h"
#import "MTROTAHeader.h"

#import "MTRError.h"
#import "MTRError_Internal.h"
Expand All @@ -25,25 +25,26 @@
#include <lib/core/OTAImageHeader.h>

@implementation MTROTAHeader
@end

@implementation MTROTAHeaderParser
+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error
{
chip::OTAImageHeaderParser parser;

parser.Init();

if (!parser.IsInitialized()) {
*error = [NSError errorWithDomain:MTRErrorDomain code:MTRErrorCodeGeneralError userInfo:nil];
if (error != nil) {
*error = [NSError errorWithDomain:MTRErrorDomain code:MTRErrorCodeGeneralError userInfo:nil];
}
return nil;
}

chip::ByteSpan buffer = AsByteSpan(data);
chip::OTAImageHeader header;
CHIP_ERROR err = parser.AccumulateAndDecode(buffer, header);
if (err != CHIP_NO_ERROR) {
*error = [MTRError errorForCHIPErrorCode:err];
if (error != nil) {
*error = [MTRError errorForCHIPErrorCode:err];
}
parser.Clear();
return nil;
}
Expand All @@ -70,3 +71,12 @@ + (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __auto
return headerObj;
}
@end

@implementation MTROTAHeaderParser

+ (nullable MTROTAHeader *)headerFromData:(NSData *)data error:(NSError * __autoreleasing *)error
{
return [MTROTAHeader headerFromData:data error:error];
}

@end
2 changes: 1 addition & 1 deletion src/darwin/Framework/CHIP/Matter.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
#import <Matter/MTRKeypair.h>
#import <Matter/MTRManualSetupPayloadParser.h>
#import <Matter/MTRNOCChainIssuer.h>
#import <Matter/MTROTAHeaderParser.h>
#import <Matter/MTROTAHeader.h>
#import <Matter/MTROTAProviderDelegate.h>
#import <Matter/MTROnboardingPayloadParser.h>
#import <Matter/MTRPersistentStorageDelegate.h>
Expand Down
16 changes: 8 additions & 8 deletions src/darwin/Framework/Matter.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
1ED276E026C57CF000547A89 /* MTRCallbackBridge.mm in Sources */ = {isa = PBXBuildFile; fileRef = 1ED276DF26C57CF000547A89 /* MTRCallbackBridge.mm */; };
1ED276E226C5812A00547A89 /* MTRCluster.mm in Sources */ = {isa = PBXBuildFile; fileRef = 1ED276E126C5812A00547A89 /* MTRCluster.mm */; };
1ED276E426C5832500547A89 /* MTRCluster.h in Headers */ = {isa = PBXBuildFile; fileRef = 1ED276E326C5832500547A89 /* MTRCluster.h */; settings = {ATTRIBUTES = (Public, ); }; };
1EDCE545289049A100E41EC9 /* MTROTAHeaderParser.h in Headers */ = {isa = PBXBuildFile; fileRef = 1EDCE543289049A100E41EC9 /* MTROTAHeaderParser.h */; settings = {ATTRIBUTES = (Public, ); }; };
1EDCE546289049A100E41EC9 /* MTROTAHeaderParser.mm in Sources */ = {isa = PBXBuildFile; fileRef = 1EDCE544289049A100E41EC9 /* MTROTAHeaderParser.mm */; };
1EDCE545289049A100E41EC9 /* MTROTAHeader.h in Headers */ = {isa = PBXBuildFile; fileRef = 1EDCE543289049A100E41EC9 /* MTROTAHeader.h */; settings = {ATTRIBUTES = (Public, ); }; };
1EDCE546289049A100E41EC9 /* MTROTAHeader.mm in Sources */ = {isa = PBXBuildFile; fileRef = 1EDCE544289049A100E41EC9 /* MTROTAHeader.mm */; };
27A53C1727FBC6920053F131 /* MTRAttestationTrustStoreBridge.h in Headers */ = {isa = PBXBuildFile; fileRef = 27A53C1527FBC6920053F131 /* MTRAttestationTrustStoreBridge.h */; };
27A53C1827FBC6920053F131 /* MTRAttestationTrustStoreBridge.mm in Sources */ = {isa = PBXBuildFile; fileRef = 27A53C1627FBC6920053F131 /* MTRAttestationTrustStoreBridge.mm */; };
2C1B027A2641DB4E00780EF1 /* MTROperationalCredentialsDelegate.mm in Sources */ = {isa = PBXBuildFile; fileRef = 2C1B02782641DB4E00780EF1 /* MTROperationalCredentialsDelegate.mm */; };
Expand Down Expand Up @@ -154,8 +154,8 @@
1ED276DF26C57CF000547A89 /* MTRCallbackBridge.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; name = MTRCallbackBridge.mm; path = "zap-generated/MTRCallbackBridge.mm"; sourceTree = "<group>"; };
1ED276E126C5812A00547A89 /* MTRCluster.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRCluster.mm; sourceTree = "<group>"; };
1ED276E326C5832500547A89 /* MTRCluster.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTRCluster.h; sourceTree = "<group>"; };
1EDCE543289049A100E41EC9 /* MTROTAHeaderParser.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTROTAHeaderParser.h; sourceTree = "<group>"; };
1EDCE544289049A100E41EC9 /* MTROTAHeaderParser.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTROTAHeaderParser.mm; sourceTree = "<group>"; };
1EDCE543289049A100E41EC9 /* MTROTAHeader.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTROTAHeader.h; sourceTree = "<group>"; };
1EDCE544289049A100E41EC9 /* MTROTAHeader.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTROTAHeader.mm; sourceTree = "<group>"; };
27A53C1527FBC6920053F131 /* MTRAttestationTrustStoreBridge.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MTRAttestationTrustStoreBridge.h; sourceTree = "<group>"; };
27A53C1627FBC6920053F131 /* MTRAttestationTrustStoreBridge.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTRAttestationTrustStoreBridge.mm; sourceTree = "<group>"; };
2C1B02782641DB4E00780EF1 /* MTROperationalCredentialsDelegate.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = MTROperationalCredentialsDelegate.mm; sourceTree = "<group>"; };
Expand Down Expand Up @@ -355,8 +355,8 @@
B202528F2459E34F00F97062 /* CHIP */ = {
isa = PBXGroup;
children = (
1EDCE543289049A100E41EC9 /* MTROTAHeaderParser.h */,
1EDCE544289049A100E41EC9 /* MTROTAHeaderParser.mm */,
1EDCE543289049A100E41EC9 /* MTROTAHeader.h */,
1EDCE544289049A100E41EC9 /* MTROTAHeader.mm */,
27A53C1527FBC6920053F131 /* MTRAttestationTrustStoreBridge.h */,
27A53C1627FBC6920053F131 /* MTRAttestationTrustStoreBridge.mm */,
88EBF8CB27FABDD500686BC1 /* MTRDeviceAttestationDelegate.h */,
Expand Down Expand Up @@ -556,7 +556,7 @@
7596A84828762783004DAE0E /* MTRAsyncCallbackWorkQueue.h in Headers */,
5A7947E527C0129F00434CF2 /* MTRDeviceController+XPC.h in Headers */,
B2E0D7B4245B0B5C003C5B48 /* MTRError_Internal.h in Headers */,
1EDCE545289049A100E41EC9 /* MTROTAHeaderParser.h in Headers */,
1EDCE545289049A100E41EC9 /* MTROTAHeader.h in Headers */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -699,7 +699,7 @@
3CF134A9289D8D800017A19E /* MTRCSRInfo.m in Sources */,
991DC0892475F47D00C13860 /* MTRDeviceController.mm in Sources */,
B2E0D7B7245B0B5C003C5B48 /* MTRQRCodeSetupPayloadParser.mm in Sources */,
1EDCE546289049A100E41EC9 /* MTROTAHeaderParser.mm in Sources */,
1EDCE546289049A100E41EC9 /* MTROTAHeader.mm in Sources */,
1EC4CE5D25CC26E900D7304F /* MTRBaseClusters.mm in Sources */,
51E0310127EA20D20083DC9C /* MTRControllerAccessControl.mm in Sources */,
1ED276E226C5812A00547A89 /* MTRCluster.mm in Sources */,
Expand Down