ASF4 API

1 Advanced Software Framework Version 4 (ASF4) Introduction and Context
This chapter starts with an overview of the features and objectives of ASF4. The context in the larger SW/Tools ecosystem is defined, giving a relation between the ASF4, START, and the IDE. A high-level work-flow overview is presented and documentation resources are described, to give insight into which references to use for what.
2 Software Architecture
3 Driver Implementation and Design Conventions
4 AC Drivers
5 ADC Drivers
6 Analog Glue Function
7 Audio Driver
8 CAN Driver
9 CRC Driver
10 Calendar Drivers
- 10.1 Calendar Bare-bone Driver
  - 10.1.1 Structs
  - 10.1.2 Typedefs
  - 10.1.3 Functions
    - 10.1.3.1 calendar_init
      Initialize the Calendar HAL instance and hardware.
    - 10.1.3.2 calendar_deinit
      Reset the Calendar HAL instance and hardware.
    - 10.1.3.3 calendar_enable
      Enable the Calendar HAL instance and hardware.
    - 10.1.3.4 calendar_disable
      Disable the Calendar HAL instance and hardware.
    - 10.1.3.5 calendar_set_baseyear
      Configure the base year for calendar HAL instance and hardware.
    - 10.1.3.6 calendar_set_time
      Configure the time for calendar HAL instance and hardware.
    - 10.1.3.7 calendar_set_date
      Configure the date for calendar HAL instance and hardware.
    - 10.1.3.8 calendar_get_date_time
      Get the time for calendar HAL instance and hardware.
    - 10.1.3.9 calendar_set_alarm
      Config the alarm time for calendar HAL instance and hardware.
    - 10.1.3.10 calendar_get_version
      Retrieve the current driver version.
- 10.2 Calendar RTOS Driver
11 Camera Driver
12 Cryptography (AES) Driver
13 DAC Drivers
14 Delay Driver
15 Digital Glue Logic
16 Ethernet MAC Driver
17 Event System Driver
18 External Bus Driver
19 External IRQ Driver
20 Flash Driver
21 Frequency Meter Drivers
22 Graphic LCD Driver
23 Graphics Processing Unit Driver(2D)
24 Hash Algorithm Driver
25 Helper Drivers
26 I2C Drivers
27 I2S Controller Driver
28 MCI Drivers
29 PAC Driver
30 PWM Driver
31 Position Decoder Driver
32 Quad SPI Drivers
33 RAND Driver
34 SPI Drivers
35 Segment LCD Drivers
36 Temperature Sensor Drivers
37 Timer Driver
38 USART Drivers
39 USB Drivers
40 Utility Drivers
41 WDT Driver
42 Revision History
The Microchip Web Site
Customer Change Notification Service
Customer Support
Microchip Devices Code Protection Feature
Legal Notice
Trademarks
Quality Management System Certified by DNV
Worldwide Sales and Service

10.1.3.1 calendar_init

Initialize the Calendar HAL instance and hardware.

int32_t calendar_init(
    struct calendar_descriptor *const calendar,
    const void * hw
)

Parameters

calendar

Type: struct calendar_descriptor *const

Pointer to the HAL Calendar instance.

hw

Type: const void *

Pointer to the hardware instance.

Returns

Type: int32_t

Operation status of init

0: Completed successfully.